- About The Project
- Getting Started
- Roadmap
- Contributing
- Common Issues
- License
- Contact
- Acknowledgements
COVID-19 Symptom Study is an open source Android and iOS app whose goal is to stop the spread of COVID-19 disease and help identify people who are at risk sooner.
The COVID-19 Symptom Study was designed by doctors and scientists at King's College London, Guys and St Thomas’ Hospitals working in partnership with ZOE Global Ltd – a health science company.
If you're doing research on COVID-19 and you want to contribute or believe this initiative can help your efforts, please let us know at [email protected]
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- npm
- expo-cli
npm install npm@latest -g
npm install expo-cli --g
-
Clone the repo
git clone [email protected]:zoe/covid-tracker-react-native.git
-
When you first start your application you should see the IP address in the console (located above the QR code). For example:
exp://123.456.7.890:19000
Copy the host part of the IP address only.
-
Create a
.env
file - please note thathttp://
is required otherwise API requests will fail.echo "API_URL=http://<ip_address_host_here>:3000" > .env
e.g.
echo "API_URL=http://123.456.7.890:3000" > .env
-
Run the following command to create
AMPLITUDE_KEY
environment variable:echo "AMPLITUDE_KEY=test_key" > .env
-
Create an empty
./google-services.json
file in the root of the application.echo "{}" > google-services.json
-
Run the following commands
npm install expo start
-
Run the mock server
npm run mock-server
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated - see the contributing guidelines.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
These are some known, common issues and their solutions:
- Changes to .env don't get picked up.
- Solution: Change some of the source code or restart the expo project running
expo start -c
Distributed under the Apache 2.0 License. See LICENSE
for more information.
ZOE Engineering - [email protected]