abubuwe / covid-tracker-react-native

ZOE COVID Study

Table of Contents

• About The Project
• Getting Started
  • Prerequisites
  • Installation
  • Tests
• Roadmap
• Contributing
• Common Issues
• License
• Contact
• Acknowledgements

About The Project

The ZOE COVID 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 App is available in the UK, US and Sweden on the Apple App Store and Google Play Store. It was launched in late March, 2020 and has over 4 million contributors. It's available free and works on most smartphones and tablets. To find at more, see https://covid.joinzoe.com.

The ZOE COVID 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]

Built With

• React Native
• Expo

Getting Started

Prerequisites

• yarn
• cocopods

# Install node.js / npm
https://nodejs.org/en/

# Install Homebrew
https://brew.sh/

# Yarn
npm install --global yarn

# Ruby
brew install ruby
sudo gem update --system
brew cleanup -d -v

# Cocopods (1.10.1)
brew install cocoapods
brew link --overwrite cocoapods

sudo xcode-select --switch /Applications/Xcode.app

Installation

# Clone the repo
git clone [email protected]:zoe/covid-tracker-react-native.git

# cd into the project root
cd ./covid-tracker-react-native

# Setup .env file variables
echo "NAME='Staging'" >> .env
echo "API_URL=http://<YOUR_LOCAL_IP_ADDRESS OR TUNNEL>:3000 " >> .env
echo "AMPLITUDE_KEY=test_key" >> .env

# Setup an empty google-services.json
echo "{}" > google-services.json

# Setup a debug keystore
keytool -genkey -v -keystore android/app/debug.keystore -storepass android -alias androiddebugkey -keypass android -keyalg RSA -keysize 2048 -validity 10000

Run the Mock Server (External Contributors)

Start the mock server in a different terminal.

The address of the mock-server should be added as API_URL in the .env file.

The iOS Simulator won't work with the value http://localhost:3000

You must use your local IP address or use a tunnel like ngrok.

yarn mock-server

Build & Run the App

yarn install
yarn ios
yarn android

Tests

Run unit & integration tests

yarn test

Run the Detox E2E tests (iOS only as of April 2021)

Set up Detox Pay attention to the iOS dependencies!

Build a binary with Detox - this will be used by the test suite to conduct your tests:

detox build

Then run the tests:

detox test

Style guide

Please refer to the contributing guidelines.

Git usage

For working with git we follow the Gitflow Workflow, to read all about it see the following explanation: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow

To summarise it:

• The main and develop branches are protected. It is not possible to directly commit to them.
• Developing is done on feature branches which are branched from develop and merged into develop through pull requests. Naming of these branches: feature/(short description of the feature)
• Bugfixes are done on bugfix branches which are branched from main and merged into main through pull requests. Naming of these branches: bugfix/(short description of the bugfix)

Pull Requests

It is expected of the initiator of the PR to merge it themself after a reviewer approved it.

Our PR merging strategy is to squash the branch into develop and then fast-forward develop into master for a release.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated - see the contributing guidelines.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

Contact

ZOE Engineering - [email protected]

Acknowledgements

• Contributor Covenant