README.md
# Pride in London App
[](https://circleci.com/gh/redbadger/pride-london-app)
[](https://codeclimate.com/github/redbadger/pride-london-app/maintainability)
[](https://codeclimate.com/github/redbadger/pride-london-app/test_coverage)
iOS: https://itunes.apple.com/gb/app/pride-in-london/id1250496471
Android: https://play.google.com/store/apps/details?id=org.prideinlondon.festival
<!-- Generateed with markdown-toc (https://github.com/jonschlinkert/markdown-toc) -->
<!-- toc -->
* [Running](#running)
* [Prerequisites](#prerequisites)
* [Environment Variables](#environment-variables)
* [Running](#running-1)
* [iOS](#ios)
* [Android](#android)
* [Debugging](#debugging)
* [Generating test data](#generating-test-data)
* [Contributing](#contributing)
* [Architecture Decision Records](#architecture-decision-records)
* [Links](#links)
<!-- tocstop -->
## Installation and setup
### Prerequisites
* [Node.js](https://nodejs.org/en/download/)
* [Watchman](https://facebook.github.io/watchman/docs/install.html)
* [Install Yarn](https://yarnpkg.com/en/docs/install)
* `$ yarn global add react-native-cli`
More information on getting started can be found here: https://facebook.github.io/react-native/docs/getting-started.html under the `Building projects with React Native` tab.
#### General
Clone the repository
`$ git clone git@github.com:redbadger/pride-london-app.git`
And install dependencies
`$ yarn`
#### iOS
* Install Xcode from the App Store and accept the license agreement.
* Run Xcode once so that it can install additional components it will need.
To develop on a real device locally you will need to install the development provisioning profile from fastlane.
Install fastlane using
```
[sudo] gem install fastlane -NV
```
or alternatively using `brew cask install fastlane`
You can then run the following command from the ios folder:
```
fastlane match development --readonly
```
You will need access to the private `match-ios-certificates` repo and will be prompted for the passphrase. Ask on the channel to get this sent to you in a secure way ;) On success you should be presented with the installed certificates and provisioning profile for org.prideinlondon.festival.
Next, open Xcode and the PrideLondonApp.xcodeproj. Plug in your device via USB, and select it in the device dropdown in the top left of Xcode. Then hit the build (Play) button.
#### Android
* Install [Android Studio](https://developer.android.com/studio/index.html).
* Install the Android SDK and necessary components.
* Open Android Studio. If this is the first time you open it, it will prompt you to install the Android SDK. You can proceed with the default settings.
* Select "Open an existing Android Studio project" and select the `./android` folder in this repository. This will help you to get the necessary dependencies installed.
* Android Studio will automatically try to build the project. You will see the Gradle process running.
* When dependencies are missing (e.g. SDK Platform or build tools), it will error and show a link to install them (e.g. "Install Build Tool xx.x.x and sync project"). Click on the link (in the Gradle Sync tab) to resolve. Repeat this until you get a BUILD SUCCESSFUL message.
* It will also automatically create the file `./android/local.properties` with a entry `sdk.dir=<path to your android sdk>`, which is required for the build to work. You will need this in the next step
* Create and start an emulator (aka AVD (Android Virtual Device)).
* Open Android Studio and click on the AVD Manager icon (4th from the far right) in the toolbar (this will appear when the project compiled correctly).
* Choose any device you want.
* Select a system image. Choose a recommended one (e.g. API 27). Click on the download link next to the image name. It will automatically start downloading.
* Click next through to finish.
* Start your AVD by clicking the green play button under actions.
* Add `<path to your android sdk>/platform-tools` (find it in `./android/local.properties`) to your `PATH`. This is required because React Native will run `adb` to install the app on your emulator/device. e.g. add
```
export PATH="<path-to-sdk>/platform-tools:$PATH"
```
to your `.bashrc`/`.zshrc`
* Make sure you have Java 8 installed (Java 9 won't work). If you wany, you can point `JAVA_HOME` to the embedded JDK from Android Studio to make sure you have a JDK version, which works with Android.
### Environment Variables
In order to run the application locally you will need to find and add some environment variables to the project. These can be found in `.env.example`. Copy this file into another file called `.env`:
```bash
cp .env.example .env
```
And fill in the required variables from the appropriate developer portals (e.g. app.contentful.com/spaces/\<space-id\>/api/keys) - use the Delivery API key.
## Running
### iOS
* `yarn run-ios [--simulator="iPhone X"]`
### Android
* `yarn run-android`
### Debugging
The recommended tool for debugging is [React Native Debugger](https://github.com/jhen0409/react-native-debugger) which has built in support for Redux Devtools.
To install React Native Debugger:
```bash
brew update && brew cask install react-native-debugger
```
Then to debug:
1. Close any other debugger windows you have open
1. Open the App from your Applications folder
1. Start debugging in the app using one of the following methods:
| Platform | Command |
| ----------- | --------------------------------------------------------------------------------- |
| **iOS** | Press Cmd+R to reload, Cmd+D or shake for dev. |
| **Android** | Double tap R on your keyboard to reload, shake or press menu button for dev menu. |
## Generating test data
> Note: You do not need to do this if you are just getting your environment set up. This is for filling the remote CMS with mock data for testing purposes.
In order to fill the test CMS space with test data you can use our `generate-content` script. It goes without saying make sure you are doing this on a test CMS rather than production.
To generate test data:
```bash
node ./scripts/generate-content.js generate -s <space_id> -a <access_token>
```
To specify a specific number of items to generate just pass a number as the first argument:
```bash
node ./scripts/generate-content.js generate -s <space_id> -a <access_token> 5
```
To delete the generated data again:
```bash
node ./scripts/generate-content.js delete -s <space_id> -a <access_token>
```
For both commands you can skup the `-s` and `-a` flags by setting the environment variables `CONTENTFUL_SPACE_ID` and `CONTENTFUL_MANAGEMENT_KEY` respectively. E.g.
```bash
export CONTENTFUL_SPACE_ID=<space_id>
export CONTENTFUL_MANAGEMENT_KEY=<access_token>
node ./scripts/generate-content.js generate 5
```
### Tests
#### E2E
End to end tests use [Detox](https://github.com/wix/detox/blob/master/docs/README.md) with [Jest](https://facebook.github.io/jest/docs/en/api.html) as the test runner. Some [setup](https://github.com/wix/detox/blob/master/docs/Introduction.GettingStarted.md) is required for running the tests locally.
## Contributing
Pieces of work currently up for grabs will be listed on the [issues page](https://github.com/redbadger/pride-london-app/issues) and tracked on the [projects page](https://github.com/redbadger/pride-london-app/projects). If you are able to work on the piece of work, comment on the issue. You can also discuss the feature in the isssue page. Be honest about if you have the time to work on it, there's no shame in parking a piece of work and letting someone else pick it up if you're too busy.
Follow the [contribution guidelines](./CONTRIBUTING.md) to have a smooth experience getting your changes in.
### Architecture Decision Records
We will keep a collection of records for "architecturally significant" decisions: those that affect the structure, non-functional characteristics, dependencies, interfaces, or construction techniques.
When making such changes please include a new ADR in your PR.
* Install `adr-tools`: https://github.com/npryce/adr-tools
* To create a new record: `adr new Implement as Unix shell scripts`
To find out more about ADRs have a read of this article: http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions
## Links
* [CI Pipeline](https://circleci.com/gh/redbadger/workflows/pride-london-app): View and debug builds
* We would like to thank [BrowserStack](https://www.browserstack.com) for allowing us to use their resources to test the Pride in London App for free!
[](https://www.browserstack.com)
* We would like to thank [Bugsnag](https://www.bugsnag.com) for allowing us to use their tool to monitor the Pride in London App for free