AiSpec

Project Name: AiSpec

Bundle Id / Package Name: com.simform.aispec

---

Project Desctiption

A AiSpec 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

1. Open the project directory in to terminal
2. Run and build for either OS

• Run iOS app

  yarn run ios

  • Run iOS app in preview envrionment

  yarn run ios:preview

  • Run iOS app in production envrionment

  yarn run ios:prod

• Run Android app

  yarn run android

  • Run Android app in preview environment

  yarn run android:preview

  • Run Android app in production environment

  yarn run android:prod

• Note: After each change to the app.config.js file, you need to run the prebuild command for the corresponding environment.

   yarn prebuild:dev

   yarn prebuild:preview

   yarn prebuild:prod

• Note: Before generating a build in Android Studio or Xcode, you need to load the appropriate environment using the following commands. After that, you can proceed with building from Android Studio or Xcode.

   yarn copy-env:dev

   yarn copy-env:preview

   yarn copy-env:prod

How to generate build

• To generate a preview release build for your React Native project, follow these steps based on your platform:

  • For Android
    • i.e. Preview release build

     yarn build:android:preview

    • Note: Generates only an APK file, located at ~/PROJECT_DIR/android/app/build/.
  • For iOS
    • i.e. Preview release build

     yarn build:ios:preview YOUR-TEAM-ID

    • To export the IPA, pass true as an argument in the build command.

     yarn build:ios:preview YOUR-TEAM-ID true

    • Note: The IPA and archive will be located at ~/PROJECT_DIR/ios/ios/build.

• 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.