snak3

SNAK3 ? ?

TABLE OF CONTENTS

• ✅  Requirements
  • Node v16
  • Environment Variables
• ?  Scripts
  •   Starting the App
  • ?  Building the App
  • ?  Testing the App

REQUIREMENTS

• Node v16

  This project uses Node v16.

  NVM is a great tool for managing / switching between node versions on your device. you can use nvm use <version_number> to switch to a particular version or nvm use to extract the version number from the .nvmrc file.

• Environment Variables

  You will need the respective environment variables for each environment you'd like to run or else the app wont start. Please ask a developer of this project for the respective .env files.

  in your root directory, please create the following files: .env, .env.local, .env.dev, .env.staging, .env.qa, and .env.prod

  For each file please add the current line: REACT_APP_ENV=<environment>, where <environment> matches the environment name for each of the files listed right above.

SCRIPTS

• Starting the App

  First and foremost install all required packages by running npm i or by running yarn install.

  Note: The most reliable method is using yarn install.

  • yarn start:app:local   (USE AS DEFAULT)

    Starts the app in local environment

  • yarn start:app:dev

    Starts the app in dev environment

  • yarn start:app:staging

    Starts the app in staging environment

  • yarn start:app:qa

    Starts the app in qa environment

  • yarn start:app:prod

    Starts the app in prod environment

• Building the App

  When building apps using a specific environment, the resulting build artifacts will be saved to /builds/<env>/build-<env>-<version-number>. The latest build will also always overwrite the artifacts found in /build.

  • yarn build:dev

    Builds the app using dev environment

  • yarn build:staging

    Builds the app using staging environment

  • yarn build:qa

    Builds the app using qa environment

  • yarn build:prod

    Builds the app using prod environment

• Testing the App

  • yarn test

    Launches the test runner in the interactive watch mode.
    See the section about running tests for more information.