Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feat/update readme #170

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Feat/update readme #170

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
43bf251
Update README with additional Android setup instructions
cnguyen812 Jun 30, 2022
8e35533
Update README with integration instructions
cnguyen812 Jun 30, 2022
4b4c701
Fix README step numbers
cnguyen812 Jun 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 21 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,22 @@ Install dependencies with `yarn` >= 14.15.0
3. Build and deploy to simulator `yarn ios` or device `yarn ios:device`

### Android
1. `yarn start` to start dev server
2. Build and deploy to simulator or device `yarn android`
1. Install a JDK:

1.1 Install JDK 1.8.0_x (1.7 = Java 7, 1.8 = Java 8, etc.) where x is the latest update number (currently 1.8.0_333). You can try a newer JDK but some dependencies might not compile properly.

1.2 Add a `JAVA_HOME` environment variable to your `~/.profile` or `~/bash_profile` set to your JDK folder. *eg.* `JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8_0_333.jdk/Contents/Home`

2. Google TapAndPay setup:

2.1 Google only makes this repository available if you have a TapAndPay dev account, we have one as a team so ask a team member to send you an ENCRYPTED email with a copy of the TapAndPay repository.

2.2 Create a `.m2/` directory somewhere (I put mine in the parent dir of the app root dir so I don't accidentally check it in) then copy the repository folder you received into the `.m2` folder so the path looks like `../.m2/repository/`.

2.3 From your home directory, open or create `~/.gradle/gradle.properties` and add `M2_REPOSITORY_URL=../../../.m2/repository` (or wherever you put yours, the path should be relative to `[app root]/android/app/build.gradle`).

3. `yarn start` to start dev server
4. Build and deploy to simulator or device `yarn android`

#### Accessing your local server
To make requests to your local server, first take your local BitPay server cert and copy it into `android/app/src/main/res/raw` folder in either .pem or .der format.
Expand Down Expand Up @@ -42,6 +56,11 @@ This project uses `react-redux` https://react-redux.js.org/ for state management
1. In `src/contants/config.ts` change `APP_LOAD_STORY_BOOK=false` to `APP_LOAD_STORY_BOOK=true`
2. Run `yarn <platform>` ex: `yarn ios`. Since we set `APP_LOAD_STORY_BOOK=true`, this runs Storybook instead of your actual app.

## Integrations
To test integrations such as Braze, Dosh, etc. you will need to get API keys from another team member. Then create `.env.production` and `.env.development` in the app root by copying the `.env.template` contents and populating the values appropriately.

To switch to using dev or prod keys, run `yarn set:dev` or `yarn set:prod` respectively which will run replace scripts to populate these values into the appropriate build files, or run `yarn reset:dev` or `yarn reset:prod` to reset values.

## Deeplinking
Test deeplinking via command line with these commands (note: ampersand must be escaped for multiple params):

Expand Down