lori/drip
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
bl00dymarie
2019-02-01 13:10:33 +00:00
parent b841ca9a1f
commit 46aa596c7a
1 changed files with 37 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15 -14
View File
@@ -8,24 +8,25 @@ The app is build in React Native and currently developed for Android.
Here --> you will find our [contributing guide](https://gitlab.com/bloodyhealth/drip/blob/master/CONTRIBUTING.md). Here --> you will find our [contributing guide](https://gitlab.com/bloodyhealth/drip/blob/master/CONTRIBUTING.md).
## Development setup ## Development setup
1. Install [Android Studio](https://developer.android.com/studio/) - you'll need it to install some dependencies. 1. Install [Android Studio](https://developer.android.com/studio/) - you'll need it to install some dependencies.
1. 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: 1. 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 $ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash
nvm install v8 $ nvm install v8
``` ```
1. Clone this repository: 1. Clone this repository:
``` ```
git clone git@gitlab.com:bloodyhealth/drip.git $ git clone git@gitlab.com:bloodyhealth/drip.git
cd drip $ cd drip
``` ```
and run and run
``` ```
npm install $ npm install
``` ```
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 see the [nodejs-mobile repository](https://github.com/janeasystems/nodejs-mobile) for the necessary prerequisites for your system. 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 see the [nodejs-mobile repository](https://github.com/janeasystems/nodejs-mobile) for the necessary prerequisites for your system.
@@ -34,19 +35,18 @@ Here --> you will find our [contributing guide](https://gitlab.com/bloodyhealth/
1. Open a terminal and run 1. Open a terminal and run
``` ```
npm run android $ npm run android
``` ```
1. To see logging output, run the following command in another tab: 1. To see logging output, run the following command in another tab:
``` ```
npm run log $ npm run log
``` ```
1. Run 1. Run the following command and select enable hot reloading (see https://facebook.github.io/react-native/docs/debugging.html):
``` ```
adb shell input keyevent 82 $ adb shell input keyevent 82
``` ```
and select enable hot reloading (see https://facebook.github.io/react-native/docs/debugging.html)
1. We recommend installing an [ESLint plugin in your editor](https://eslint.org/docs/user-guide/integrations#editors). 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. 1. We recommend installing an [ESLint plugin in your editor](https://eslint.org/docs/user-guide/integrations#editors). 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.
@@ -58,7 +58,7 @@ 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: 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}" $ 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. Now, `which java` should output `/Applications/Android Studio.app/Contents/jre/jdk/Contents/Home/bin/java`, and the correct Java version should be used.
@@ -66,13 +66,13 @@ Now, `which java` should output `/Applications/Android Studio.app/Contents/jre/j
#### [MacOS] Ninja #### [MacOS] Ninja
If `npm` says `CMake was unable to find a build program corresponding to "Ninja".`: If `npm` says `CMake was unable to find a build program corresponding to "Ninja".`:
``` ```
brew install ninja $ brew install ninja
``` ```
### [MacOS] adb not on the path ### [MacOS] adb not on the path
If you get error messages about `adb` not being found on your 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 $ ln -s ~/Library/Android/sdk/platform-tools/adb /usr/local/bin/adb
``` ```
### [Windows 10] react native problems ### [Windows 10] react native problems
@@ -82,7 +82,7 @@ Unfortunately, the react native version we use doesn't work on Windows 10 it see
## Tests ## Tests
You can run the tests with: You can run the tests with:
``` ```
npm test $ npm test
``` ```
## Debugging ## Debugging
@@ -95,6 +95,7 @@ or just a random string to check if this piece of code is actually running:
More information about how the app calculates fertility status and bleeding predictions in the [wiki on Gitlab](https://gitlab.com/bloodyhealth/drip/wikis/home) More information about how the app calculates fertility status and bleeding predictions in the [wiki on Gitlab](https://gitlab.com/bloodyhealth/drip/wikis/home)
## Adding a new tracking icon ## Adding a new tracking icon
1. We use [fontello](http://fontello.com/) 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. 1. We use [fontello](http://fontello.com/) 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 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`. 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`.