Files
drip/README.md
T
Julia Friesel 8d0791c06f Update readme
2018-05-29 13:15:47 +02:00

25 lines
967 B
Markdown

# Bloody Health Cycle Tracker
A menstrual cycle tracking app that's open-source and leaves your data on your phone. Use it to track your menstrual cycle or for fertility awareness!
## Development setup
1. Start a virtual device in Android Studio (or make sure it's already running, you should see a phone on your screen)
2. Clone this repository:
```
git clone git@gitlab.com:bloodyhealth/drip.git
cd drip
```
4. Run `npm install`
5. Run `npm start`
6. Run `npm install -g react-native`
6. In another terminal tab or window, run `react-native run-android`
7. In yet another tab, run `react-native log-android` to see logging output
7. We recommend installing an [ESLint plugin in your editor](https://eslint.org/docs/user-guide/integrations#editors). There will soon be an `.eslintrc` file in this project which will be used by the plugin to check your code for style errors and potential bugs.
## Tests
You can run the tests with `npm test`.