topcoderinc / dsp-frontend

React fronted to drone series
8 stars 23 forks source link

DSP app

Requirements

Quick Start

Configuration

Configuration files are located under config and src/config directories. See Guild https://github.com/lorenwest/node-config/wiki/Configuration-Files

Name Description
PORT The port to listen
GOOGLE_API_KEY The google api key see (https://developers.google.com/maps/documentation/javascript/get-api-key#key)
API_BASE_URL The base URL for Drone API
REACT_APP_API_BASE_PATH The React app api base path`
REACT_APP_SOCKET_URL The React app app socket url`
REACT_APP_AUTH0_CLIEND_ID The React app auth0 client id`
REACT_APP_AUTH0_DOMAIN The React app auth0 domain`

Environment variables will be loaded from the .env file during build. Create the .env file based on the provided env.example

Install dependencies

npm i

Running

npm run <script> Description
build Build the app
start Serves the app in prod mode (use build first).
dev Start app in the dev mode.
lint Lint all .js files.
lint:fix Lint and fix all .js files. Read more on this.
test Run tests using mocha-webpack for all *.spec.(js|jsx) files in the src dir.

Local deploy

NODE_ENV=production npm run build
NODE_ENV=production npm run start

Heroku deploy

Prerequisites

set up

npm run heroku:[ENV]:init
npm run heroku:[ENV]:deploy

update

npm run heroku:[ENV]:deploy

npm run heroku:[ENV]:init will create a new git remote in current git repository and a new app in remote server.

npm run heroku:[ENV]:deploy line will push current branch to corresponding remote environment.

ENV can be 'prod', 'dev', 'staging', 'test'.