goals

Project Name: goals

Bundle Id / Package Name: com.simform.goals

---

Project Desctiption

A goals boilerplate to kickstart your project with some commonly used setups, components, navigation and screens.

Prerequisites

iOS : XCode(16) onwards

Android : Android Studio(Meerkat | 2024.3.1) with gradle(6.2) onwards

Editor : Visual Studio Code

How to Run the Project when using EAS

• Run iOS app

   yarn ios:build:eas:dev

  • Run iOS app in preview envrionment

  yarn ios:build:eas:preview

  • Run iOS app in production envrionment

  yarn ios:build:eas:prod

• Run Android app

  yarn android:build:eas:dev

  • Run Android app in preview environment

  yarn android:build:eas:preview

  • Run Android app in production environment

  yarn android:build:eas:prod

Note: Ensure that your eas.json file includes the projectId and slug that was generated for your project in the EAS dashboard.

There is an exception when adding the Sentry Auth token while uploading source maps to the portal. The auth token must be strictly defined as SENTRY_AUTH_TOKEN across all environments, as Sentry does not allow any suffixes in the key.

EAS environment source of truth

Build type	From EAS secrets	From local env files
EAS dev build	Pull Preview secrets locally with eas env:pull --environment preview.	Values load from the matching file, for example .env.preview.
EAS release build	Profiles read secrets directly from the EAS store; set the profile environment to "preview" in eas.json.	Inline variables inside the profile env block in eas.json, for example: already mention NODE_ENV like add all other local variables

To run EAS builds on a remote server, you need to add secrets with EXPO_PUBLIC like EXPO_PUBLIC_API_URL similar to how you've defined them in your local .env files (e.g., EXPO_PUBLIC_API_URL). Your environment variables should match the names of the secrets.

• Note: This yarn scripts will lint your code first. If there are no lint errors, then it will run the ios or android app. Otherwise it will show the lint errors in the terminal.

In the output, you'll find options to open the app in a

• Android emulator
• iOS simulator

List of all dependencies used in the project with their usage

List all dependencies from the package.json file along with their usage. This list must be updated every time you change/add any dependecy. Here are some examples:

• Framework:

  • expo

• State management libraries:

  • React Redux, redux-persist

• Middleware libraries:

  • Redux Toolkit

• Navigation:

  • react-navigation, react-native-gesture-handler, react-navigation-stack, react-native-safe-area-context, react-native-screens

• For Api

  • apisauce, axios

• Storage:

  • react-native-mmkv

• Crash report:

  • @sentry/react-native

• For Validations:

  • formik, yup

• For Utilities

  • lodash, i18next, react-i18next, expo-localization, react-native-permissions

Following accounts are used for the mentioned platform

Mention all the accounts used for various development and deployement platforms. Just email/username should be mentioned but never a password. Make sure this information stays in a private repository. If your repository is public, do not share this kind of private information via readme. Provide another private source. Like a private file on our zoho or a file in Microsoft Teams.