Huddle

Huddle is a medical document organizing and sharing mobile application built using React Native.

Dependencies

I am certainly missing some because I did not set this project up from a clean install (nor did I take comprehensive notes) but here are key software requirements:

I believe all team members are using MacOs computers.

Homebrew

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Node.js

The React Native docs recommend using homebrew, but I do not. Use a Node version manger like nvm or n. This will allow you to not lose your ability to develop on legacy apps, and should make the project easier to update to current Node.js versions in the future.

I suggest we use Node.js version 12

Instead of npm the team prefers yarn. Install with homebrew or if you'd rather, npm i -g yarn worked for me.

React Native

A good place to start is here: https://facebook.github.io/react-native/docs/getting-started.html but please install Node using a version manager.

I am on these versions:

react-native-cli: 2.0.1
react-native: 0.60.6

Cocoapods

sudo gem install cocoapods

Build

1. Clone this repository
2. run yarn install
3. Install iOS dependencies yarn pod:install
4. Run react-native run-ios or yarn android:run

Release

Android

1. Ensure .env.production have secrets
2. Build
3. Smoke test in Android phone (or Simulator)
4. Bump version /package.json and /android/app/build.gradle (Android versioning)
5. yarn android:release PROD build and Sentry sourcemap
6. Locate generated APK in huddle/app/build/outputs/apk/app-release.apk

iOS

1. Xcode GUI like normal
2. yarn ios:release Sentry sourcemap

Debug

You can use reactotron for debug network requests and console.log also will log to reactotron and browser console. You need to:

1. Install reactotron desktop app.
2. Run reactotron desktop app.
3. Run app in emulator in dev environment.

Check docs for more details.

End to End Testing

Setup

1. Install Dependencies

Execute

1. (Tab 1) Run yarn start-detox
2. (Tab 2) Run yarn detox:build && yarn detox

Standards

The Huddle team will be using the airbnb React/JSX style guide https://github.com/airbnb/javascript/tree/master/react and the airbnb JavaScript style guide https://github.com/airbnb/javascript.

Resources

https://metalab.invisionapp.com/share/HVSM5QGR5NA