Skip to content

Commit

Permalink
Merge branch 'develop' into ts-feature-flags
Browse files Browse the repository at this point in the history 
* develop:
  Add language contribution info to contributing guide (#754)
  Recommend PR best practices in PR template (#750)
  Add eslint react-hooks checks (#751)
  iOS: Added local notification in terminate function. (#521)
  Update dev README (#705)
  Better error logging in Google import (#703)
  Remove rebasing from suggestions in CONTRIBUTING.md (#724)
  • Loading branch information
@tstirrat
tstirrat committed May 3, 2020
2 parents 55dcc37 + f3d704c commit a14deaa
Show file tree
Hide file tree
Showing 17 changed files with 276 additions and 173 deletions.
3 changes: 2 additions & 1 deletion .eslintrc.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ module.exports = {
extends: [
'eslint:recommended',
'plugin:react/recommended',
'plugin:react-hooks/recommended',
'plugin:jest/recommended',
],
parser: 'babel-eslint',
plugins: ['react', 'react-native', 'detox'],
plugins: ['react', 'react-hooks', 'react-native', 'detox'],
parserOptions: {
ecmaVersion: 6,
sourceType: 'module',
Expand Down
6 changes: 4 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
<!-- ## Description -->
<!-- Please read https://github.com/tripleblindmarket/covid-safe-paths/wiki/Pull-Request-Best-Practices for recommended best practices before opening your first pull request -->

#### Description:

<!-- Description of what the PR does -->

Expand All @@ -10,6 +12,6 @@

<!-- If you're changing visuals, add a screenshot here -->

#### How to test
#### How to test:

<!-- Description of how to validate or test this PR -->
108 changes: 49 additions & 59 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

We welcome participation in an open project. We want to make it as easy as possible for people to work together, so please follow these guidelines to prepare and submit a pull request.

## How to prepare
- Filtering by [good first issues](https://github.com/tripleblindmarket/covid-safe-paths/labels/good%20first%20issue) is the recommended way to begin contributing to the project
- Localization/Language updates are handled in [Lokalise](https://lokalise.com/). More info on how to contribute [here](https://github.com/tripleblindmarket/covid-safe-paths/wiki/Localization-Contributing-Guidelines)

## Create A New Issue

- You need a Github account. You can [create one](https://github.com/signup/free) for free.

Expand All @@ -23,71 +26,71 @@ We welcome participation in an open project. We want to make it as easy as possi

cd ~ # get to your home directory or where ever you want to go

git clone https://github.com/YOURACCOUNT/covid-safe-paths
git clone git@github.com:YOURACCOUNT/covid-safe-paths.git

# change into the newly created directory
cd covid-safe-paths

# set upstream against COVID Safe Paths repository
git remote add upstream https://github.com/tripleblindmarket/covid-safe-paths.git
git remote add upstream git@github.com:tripleblindmarket/covid-safe-paths.git

```

(see also how to [fork a repo](https://help.github.com/articles/fork-a-repo/))

## Make Changes

1. Create a branch based on the `develop` branch on your forked repository. Name the branch something to reflect what you are doing. For example, if you want to add a new icon, a branch name you could use:

```bash
git checkout develop # you want to branch from the main 'develop' branch

git pull # make sure you have the latest code when you start the branch

git checkout -b "feature/new-icon" develop # new branch created!

"or"

git checkout -b "fix/new-icon" develop # new branch created!

"or"

git checkout -b "release/new-icon" develop # new branch created!
```

2. Stick to the coding style and patterns that are used already.

3. Document code! Comments are good. More comments are better. :)

4. Make commits as you desire. Ultimately they will be squashed, so make

notes to yourself. It's as simple as `git commit -m "commit message goes here"`!

5. Rebase your feature branch with upstream/develop to avoid any code conflicts:
### Create a branch

1. Always create a new branch from the latest `upstream/develop`:
```bash
git checkout develop # you want to branch from the latest 'develop' branch
git pull upstream/develop # make sure you have the latest code from upstream
git push origin develop # optional, push these changes to YOUR fork's develop branch
```
2. Create the branch. Name the branch something to reflect what you are doing.
```
git checkout -b "feature/new-icon" develop # new branch created!
"or"
git checkout -b "fix/new-icon" develop # new branch created!
"or"
git checkout -b "release/new-icon" develop # new branch created!
```
3. Stick to the coding style and patterns that are used already.
4. Document code! Comments are good. More comments are better. :)
5. Make commits as you desire. Ultimately they will be squashed, so make notes to yourself. It's as simple as `git commit -m "commit message goes here"`!

### Merge upstream/develop into your branch to get the latest changes.

```bash
# 1. Rebase Base(COVID Safe Paths) repository with fork repository - develop branch

git checkout develop # switch to base branch(local)

git fetch upstream # fetch latest commits from "COVID Safe Paths" develop branch

git rebase upstream/develop # rebase code against your forked develop branch(local)
# if you've already done this it will fail, that's fine:
git remote add upstream [email protected]:tripleblindmarket/covid-safe-paths.git

git push -f origin develop # push rebased code after resolving conflicts to forked develop branch(remote)
# ensure you are on your feature/fix branch
git checkout feature/my-feature

# 2. Rebase feature branch(local) with develop branch(local)
# get latest upstream branches e.g. upstream/develop
git fetch upstream

git checkout <feature-branch-name-you-created> # switch back to original feature branch(local) you are working
# merge upstream/develop into your local branch, this will always create a single merge commit
git merge upstream/develop --no-ff

git rebase develop # now rebase your feature branch(local) against develop branch(local)
# you may need to resolve conflicts. If so, resolve them and commit the merge:
git commit

git push origin feature/<your-feature-branch-name> # after resolving all conflicts, push your new feature branch to the remote forked repository
# push your changes up to your branch again
git push -u origin

# now your feature branch is ready for PR against COVID Safe Paths develop branch.
```

6. Start a PR to submit your changes back to the original project:
### Start a PR to submit your changes back to the original project:

- Visit https://github.com/your-git-userid/covid-safe-paths/branches

Expand All @@ -108,25 +111,10 @@ git push origin feature/<your-feature-branch-name> # after resolving all conflic

- Provide a meaningful title and description to your PR, as shown in the above image.
- Provide Issue ID on PR description to link/close the issue upon PR merged.
- If you are changing visuals, please provide screenshots so the PR reviewer can see what you've done without running it in the app.

## Helpful resources on Git

- Git commands:

```
git checkout develop
git fetch
git reset --hard origin/develop
git checkout <your_branch_name>
git rebase develop
git push -f
```

- Documentation on how to [create a Pull Request (PR) on Github](https://help.github.com/articles/using-pull-requests/) for review and merging.

**Note**: Even if you have write access, do not work directly on `master` or push directly to `develop`! All work is done against `develop` reviewed and merged via PRs, and ultimately `develop` gets merged into `master` for tagged code releases.
Expand Down Expand Up @@ -173,6 +161,8 @@ _Advanced users may install the `hub` gem and use the [`hub pull-request` comman

## Reviewing Pull Requests

- If you are using VS Code, use the [GitHub PR extension](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github), which will allow you to checkout and run anyone's PR with ease.

- Open the PR on Github. At the top of the PR page is a number which identifies it -123 and the name of the author's branch -branch-name. Copy down both of these.

* Open git bash and ensure your working directory is clean by running `git status`
Expand Down
140 changes: 115 additions & 25 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,70 +1,160 @@
# COVID Safe Paths <img align="left" src="./assets/ShieldKeyHold512x512.png" data-canonical-src="./assets/ShieldKeyHold512x512.png" width="40" height="40"/> ![Android and iOS build on MacOS](https://github.com/tripleblindmarket/covid-safe-paths/workflows/Android%20and%20iOS%20build%20on%20MacOS/badge.svg)

**Applying the technology and philosophy of Private Kit to COVID**
<div align="center">
<h1>COVID Safe Paths</h1>

<a href="https://covidsafepaths.org">
<img
height="80"
width="80"
alt="safe paths logo"
src="./assets/Safe_Paths_Logo.png"
/>
</a>

<p>
Applying the technology and philosophy of Private Kit to COVID-19
</p>

<b>**https://covidsafepaths.org | https://safepaths.mit.edu**</b>
</div>

<hr />

Help us stop COVID-19.

We’re building the next generation of secure location logging to preserve privacy and #flattenthecurve
We’re building the next generation of secure location logging to preserve privacy and _#flattenthecurve_

Location logs provide time-stamped records of where users have been, allowing them to share information with health officials accurately and quickly. This helps support contact tracing efforts to slow the spread of the virus.

What’s truly special about Safe Paths, though, is its privacy protection. Data never leaves a user's device without their password entry and explicit consent. The location log generated by Safe Paths cannot be accessed from outside the user’s device, meaning data transfer occurs only if the user chooses to share it with a researcher or health official.
What’s truly special about Safe Paths, though, is its privacy protection.

----
Data never leaves a user's device without their password entry and explicit consent. The location log generated by Safe Paths cannot be accessed from outside the user’s device, meaning data transfer occurs only if the user chooses to share it with a researcher or health official.

<img align="right" src="./assets/PreviewUI.png" data-canonical-src="./assets/PreviewUI.png"/>

Safe Paths is a ‘privacy-first’ app that allows you to log your GPS trails on your own phone. The information is stored locally and never shared with anyone (not even with us or MIT) until you explicitly decide to manually export the data. The location log generated by Safe Paths cannot be accessed from outside the user’s device. Location information can be imported and exported by the user and used in other projects and applications.
## Overview

Safe Paths is a ‘privacy-first’ app that allows you to log your GPS trails on your own phone. The information is stored locally and never shared with anyone (not even with us or MIT) until you explicitly decide to manually export the data.

The location log generated by Safe Paths cannot be accessed from outside the user’s device. However, the user can import and export their location information and use it in other projects and applications.

Safe Paths logs your device’s location once every five minutes and stores 28 days of data in under 100KB of space.

**Home page:** https://covidsafepaths.org and https://safepaths.mit.edu
### Private Kit WhitePaper

[Apps Gone Rogue: Maintaining Personal Privacy in an Epidemic](https://drive.google.com/file/d/1nwOR4drE3YdkCkyy_HBd6giQPPhLEkRc/view?usp=sharing)

### Downloads for COVID Safe Paths

_coming soon!_

**Private Kit WhitePaper:** [Apps Gone Rogue: Maintaining Personal Privacy in an Epidemic](https://drive.google.com/file/d/1nwOR4drE3YdkCkyy_HBd6giQPPhLEkRc/view?usp=sharing)
### Downloads for Private Kit (technology beta)

**Downloads for COVID Safe Paths:** _coming soon!_
[Google Play](https://play.google.com/store/apps/details?id=edu.mit.privatekit) | [Apple Store](https://apps.apple.com/us/app/private-kit-prototype/id1501903733)

**Downloads for Private Kit (technology beta):** [Google Play](https://play.google.com/store/apps/details?id=edu.mit.privatekit) | [Apple Store](https://apps.apple.com/us/app/private-kit-prototype/id1501903733)
<br />

# Development Overview

This is a React Native app version 61.5
![Android and iOS build on MacOS](https://github.com/tripleblindmarket/covid-safe-paths/workflows/Android%20and%20iOS%20build%20on%20MacOS/badge.svg)

_Safe Paths_ is a built on [React Native](https://reactnative.dev/docs/getting-started) v0.61.5

## Contributing

Read the [contribution guidelines](CONTRIBUTING.md).

## Architecture

Please refer to `docs/Private Kit Diagram.png` for a basic overview on the sequencing of generalized events and services that are used by Safe Paths.
View the [architecture diagram](docs/Private_Kit_Diagram.png) for a basic overview on the sequencing of generalized events and services that are used by Safe Paths.

## Developer Setup

Run the ```dev_setup.sh``` (Linux/MacOS) or ```dev_setup.bat``` (Windows) for needed tools. It is assumed that Android Studio and/or xcode (on macOS) is set up and configured correctly to run applications in the simulator. For Android Studio, the dev_setup script can help you, but you still may need to configure at least one android virtual device (avd) from within Android Studio first before you can run the app.
First, run the appropriate setup script for your system. This will install relevant packages, walk through Android Studio configuration, etc.

## Running
**Note:** You will still need to [configure an Android Virtual Device (AVD)](https://developer.android.com/studio/run/managing-avds#createavd) after running the script.

```yarn``` must be installed for this project, as it does a better job installing dependendies across platforms. The dev_setup script above should have done that for you.
#### Linux/MacOS

### Install modules to the correct locations
```
dev_setup.sh
```

#### Windows

1. ```yarn install``` (always do this after a new clone or checkout)
2. ```yarn install:pod``` (additional step for macOS if you want to do an iOS build)
```
dev_setup.bat
```

### Run the app in a simulator
## Running

**Note:** In some cases, these procedures can lead to the error `Failed to load bundle - Could not connect to development server`. In these cases, kill all other react-native processes and try it again.

#### Android (Windows, Linux, macOS)

To run in the Android simulator (Windows, Linux, macOS):
```
npx react-native run-android
```
or (on macOS only)

Device storage can be cleared by long-pressing on the app icon in the simulator, clicking "App info", then "Storage", and lastly, "Clear Storage".

#### iOS (macOS only)

```
yarn install:pod ## only needs to be ran once
npx react-native run-ios
```

NOTE: In some cases, these procedures can lead to the error `Failed to load bundle - Could not connect to development server`. In these cases, kill all other react-native processes and try it again.
Device storage can be cleared by clicking "Hardware" on the system toolbar, and then "Erase all content and settings".

## Contributing
### Release Builds

Read the [contribution guidelines](CONTRIBUTING.md).
Generating a release build is an optional step in the development process.

- [Android instructions](https://reactnative.dev/docs/signed-apk-android)

### Debugging

[react-native-debugger](https://github.com/jhen0409/react-native-debugger) is recommended. This tool will provide visibility of the JSX hierarchy, breakpoint usage, monitoring of network calls, and other common debugging tasks.

## Testing

Tests are ran automatically through Github actions - PRs are not able to be merged if there are tests that are failing.

### Unit Test

To run the unit tests:

```
yarn test --watch
```

[Snapshot testing](https://jestjs.io/docs/en/snapshot-testing) is used as a quick way to verify that the UI has not changed. To update the snapshots:

```
yarn update-snapshots
```

### e2e Test

**Note:** Right now, there is only e2e test support for iOS.

e2e tests are written using [_detox_](https://github.com/wix/Detox). Screenshots of each test run are saved to `e2e/artifacts` for review.

To run the e2e tests:

```
yarn detox-setup ## only needs to be run once
yarn build:e2e:ios ## needs to be run after any code change
yarn test:e2e:iphone{11, -se, 8}
```

### Manual Device Testing

Mobile devices come in many different shapes and sizes - it is important to test your code on a variety of simulators to ensure it looks correct on all device types.

Before pushing up code, it is recommended to manually test your code on the following devices:

- Nexus 4 (smaller screen)
- iPhone 8 (smaller screen)
- Pixel 3 XL (larger screen)
- iPhone 11 (screen w/ notch)
Loading

0 comments on commit a14deaa

Please sign in to comment.