This app was created to serve the need for easy to use contact tracing.
This app was created to serve the need for easy to use contact tracing.
## Usage
## Usage
The app should work as such:
The app should work as such:
1. Group/Organization leaders will be created an account on the app.
1. Group/Organization leaders will be created an account on the app.
2. Upon logging in, they will see a QR code that they can display
2. Upon logging in, they will see a QR code that they can display
3. Their members can scan this QR code, in order to create their own accounts. This way, there each member has a "parent" member, and all memberships can be traced.
3. Their members can scan this QR code, in order to create their own accounts. This way, there each member has a "parent" member, and all memberships can be traced.
4. Upon creating their account, new members will also have a QR Code they can display.
4. Upon creating their account, new members will also have a QR Code they can display.
5. Other members can scan each other QR codes in order to register a *Contact* in the backend.
6. All *Contacts* between members can be retrievable from the backend at a later time.
5. Other members can scan each other QR codes in order to register a _Contact_ in the backend.
6. All _Contacts_ between members can be retrievable from the backend at a later time.
## Development
## Development
### Prerequisites
### Prerequisites
- NodeJS
- NodeJS
- Yarn
- Yarn
### Building
### Building
- Use `yarn install` to install the necessary packages
- Use `yarn install` to install the necessary packages
- Use `yarn start` to start app in development mode in [http://localhost:3000](http://localhost:3000)
- Use `yarn start` to start app in development mode in [http://localhost:3000](http://localhost:3000)
- Use `yarn build` to build an optimized app for production.
- Use `yarn build` to build an optimized app for production.
### .env
### .env
Don't forget to copy the .env.template to .env and fill in the values
Don't forget to copy the .env.template to .env and fill in the values