README.md

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. Install Android Studio - you'll need it to install some dependencies.

2. Make sure you are running Node 8 or 9 (newer versions won’t work). It's easiest to switch Node versions using nvm, here’s how to do it:

   curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash
   nvm install v9

3. Clone this repository:

git clone git@gitlab.com:bloodyhealth/drip.git
cd drip

1. Open Android Studio and click on "Open an existing Android Studio project". Navigate to the drip repository you cloned and double click the android folder. It detects, downloads and cofigures requirements that might be missing, like the NDK and CMake to build the native code part of the project. Also check out nodejs-mobile repository for the necessary prerequisites for your system.

2. Either start a virtual device in Android Studio (or make sure it's already running, you should see a phone on your screen) or set your physical device like your phone up to run the app.

3. Open a terminal in Android Studio and run npm install

4. Run npm run android

5. In another tab, run npm run log to see logging output

6. Run adb shell input keyevent 82 and select enable hot reloading (see https://facebook.github.io/react-native/docs/debugging.html)

7. We recommend installing an ESLint plugin in your editor. There's 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.

Debugging

When running into an old version of the app try to run the following command first: react-native bundle --platform android --dev false --entry-file index.js --bundle-output android/app/src/main/assets/index.android.bundle --assets-dest android/app/src/main/res

NFP rules

More information about how the app calculates fertility status and bleeding predictions in the wiki on Gitlab