Skip to content
Snippets Groups Projects
Commit 16702284 authored by bl00dymarie's avatar bl00dymarie
Browse files

Merge branch 'edit-readme' into 'master'

Edit readme

See merge request bloodyhealth/drip!116
parents f1684a87 998f0f35
No related branches found
No related tags found
No related merge requests found
...@@ -5,28 +5,33 @@ A menstrual cycle tracking app that's open-source and leaves your data on your p ...@@ -5,28 +5,33 @@ A menstrual cycle tracking app that's open-source and leaves your data on your p
## 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. 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](https://developer.android.com/training/basics/firstapp/running-app) to run the app. 1. 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
```
2. 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
``` ```
4. 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: 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.
``` 1. 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](https://developer.android.com/training/basics/firstapp/running-app) to run the app.
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash
nvm install v9 1. Open a terminal in Android Studio and run `npm install`
```
1. Run `npm run android`
1. In another tab, run `npm run log` to see logging output
1. Run `adb shell input keyevent 82` and select enable hot reloading (see https://facebook.github.io/react-native/docs/debugging.html)
5. Run `npm install` 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.
5. Run `npm run android`
6. You may need to open your app's /android folder in Android Studio, so that 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.
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](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.
## Tests ## Tests
You can run the tests with `npm test`. You can run the tests with `npm test`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment