Run the following commands in sequence to start node application
- Install node & npm
- Install yarn
- Install expo by running
npm install --global expo-cli
- Clone the project and navigate to the root using your terminal
- Run
yarn or npm install
to install dependencies - Create
.env
file and add required private keys or add provided.env
file in root of project - Running
yarn start
will start the react-native and expo instance locally - Run either a android or ios emulator
- Using the web interface either click run on android or run on ios
name | description |
---|---|
App.js | Consist of initialisation and and routing of app |
NavigationService.js | Global Navaigation Manager allowing for full control of alerts and routing in project |
pages | Consist of all app routes |
components | Consist of individual components micro components. Each component folder is named according to the components name in the index.js file |
processors | Share functionality within the whole project |
assets | Local assets such as images and fonts using within the project |
- Use a IDE that supports plugin support such as prettier and eslint for consistent formating
- Fork the project and make adjustments based on trello board
- Send PR request with appropriate standard
- Either follow this or this for better contributions
Current user flow chart: