Skip to content

Latest commit

 

History

History
69 lines (49 loc) · 1.92 KB

README.md

File metadata and controls

69 lines (49 loc) · 1.92 KB

Subscripshare

API

The easiest way to develop on Subscripshare is to install:

Make sure your Docker installation is working fine by typing docker ps. Under Mac OS X you may have to run some commands after installing to get Docker working in your shell.

Make sure your user is part of the docker group to avoid running all commands as root.

For Mac OS X users, the project folder must be in a subfolder of /Users, due to an issue in docker-machine.

Clone the project

Specify environment variables in docker-compose.yml

docker-compose run --rm api npm install
docker-compose up

Mobile app

Getting started

Follow the Setup guide to get started.

Development workflow

To learn how to structure your application and use the Redux application architecture, read the Architecture guide for more details.

First of all:

  cd client
Start the application in iOS simulator
  react-native run-ios
Start the application in Android simulator

(If using the stock emulator, the emulator must be running)

  react-native run-android
Run unit tests
  npm test
Run tests every time code changes
  npm run test:watch
Generate code coverage report
  npm run coverage

Read the Testing guide for more information about writing tests.

Deployment

Read the Deployment guide to learn how to deploy the application to test devices, app stores, and how to use Code Push to push updates to your users immediately.