README.md

Technologies

Vox application is built with Expo and Typescript.

Getting started

Installing dependencies

To be able to run the application on iOS and Android:

• install Yarn
• run yarn install to install the project dependencies

Building/Running the app locally

• copy the .env file to .env.*.local and fill in the environment variables
• download the GoogleService-Info.plist and google-services.json files from the Firebase console and place them in the config/ folder
• run yarn run start to start the react-native bundler
• run yarn run ios to start the iOS app
• run yarn run android to start the Android app
• run yarn run web to start the web app

Deploy the app

• versioning structure : ex -> 1.0.0#1 -> appVersion#eas_update_version
  • appVersion = runtimeVersion
  • eas_update_version = eas_update_version

EAS Update

• bump "eas_update_version" in app.json in extra
• use deploy workflow, select your branch, environement, and EAS deploy type to "update"

build the app for internal testing

• use deploy workflow, select your branch, staging environement, and EAS deploy type to "build"

Deploying the app for production

• bump "version" in app.json
• use deploy workflow, select your branch, productiom environement, and EAS deploy type to "build"

Contribution

• make a pull request to the develop branch
• make sure to run prettier while developing with bun prettier-watch or use bun format to format the code
• please avoid to :
  • use any type
  • use console.log for debugging
  • use @ts-ignore or @ts-nocheck to ignore typescript errors
  • use classes as much as possible