README.md

drip, the open-source cycle tracking app

A menstrual cycle tracking app that's open-source and leaves your data on your phone. Use it to track your menstrual cycle and/or for fertility awareness! Find more information on our website.

The app is build in React Native and currently developed for Android.

Development setup

1. Install Android Studio - you'll need it to install some dependencies.

2. Make sure you are running Node 8 (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 v8

3. Clone this repository:

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

   and run

   npm install

4. 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 see the nodejs-mobile repository for the necessary prerequisites for your system.

5. Either start a virtual device in Android Studio or set your physical device like your Android phone up to run the app.

6. Open a terminal and run npm run android

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

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

9. 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.

Troubleshooting

[MacOS] Java problems

Make sure that you have Java 1.8 by running java -version.

If you don't have Java installed, or your Java version is different, the app may not work. You can try just using Android Studio's Java by prepending it to your $PATH in your shell profile:

export PATH="/Applications/Android Studio.app/Contents/jre/jdk/Contents/Home/bin:${PATH}"

Now, which java should output /Applications/Android Studio.app/Contents/jre/jdk/Contents/Home/bin/java, and the correct Java version should be used.

[MacOS] Ninja

If npm says CMake was unable to find a build program corresponding to "Ninja".: brew install ninja

[MacOS] adb not on the path

If you get error messages about adb not being found on your path: ln -s ~/Library/Android/sdk/platform-tools/adb /usr/local/bin/adb

[Windows 10] react native problems

Unfortunately, the react native version we use doesn't work on Windows 10 it seems, find more info here.

Tests

You can run the tests with npm test.

Debugging

In order to see logging output from the app, run npm run log in a separate terminal. You can output specific code you want to see, with: console.log(theVariableIWantToSeeHere) or just a random string to check if this piece of code is actually running: console.log("HELLO").

NFP rules

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

Adding a new tracking icon

1. We use fontello to create icon fonts for us. You need to upload the complete set of tracking icons (bleeding, mucus, ...) including the new icon you wish to add, all in SVG.
2. Download webfont from fontello
3. Copy both the content of config.json and font.tff into assets/fonts, replacing it with the current content of config-drip-icon-font.json and drip-icon-font.tff.
4. Now run the following command in your console: $ react-native link
5. You should be able to use the icon now within drip, e.g. in Cycle Day Overview and on the chart.