Merge pull request #6 from tohjustin/development

v2.1.0

.env.example

@@ -1,9 +1,12 @@
 REACT_APP_VERSION=$npm_package_version
 REACT_APP_NAME=$npm_package_name
+
+# Fill in the following variables
 REACT_APP_DOMAIN=https://my-app-domain.com
-REACT_APP_RAVEN_PUBLIC_DSN=https://ABC@sentry.io/ZYX
 REACT_APP_REPOSITORY_URL=https://github.com/<user>/<npm_package_name>
 
+# Optional variables (only if you want to use Sentry)
+REACT_APP_RAVEN_PUBLIC_DSN=https://ABC@sentry.io/ZYX
 SENTRY_ORG=MY_ORG
 SENTRY_PROJECT=MY_PROG
 SENTRY_AUTH_TOKEN=MY_TOKEN

README.md

@@ -4,46 +4,49 @@
 [![codecov](https://codecov.io/gh/tohjustin/coincharts/branch/master/graph/badge.svg)](https://codecov.io/gh/tohjustin/coincharts)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
+<p align="center">
+  <img src="./docs/screenshot.png">
+</p>
+
 A cryptocurrency price chart based off [https://www.coinbase.com/charts](https://www.coinbase.com/charts)
 
 * Bootstrapped with [create-react-app](https://github.com/facebookincubator/create-react-app)
-* Built with [React.js](https://facebook.github.io/react/), [Redux](https://redux.js.org/), [Redux-Saga](https://redux-saga.js.org/), [styled-components](https://www.styled-components.com/), [D3.js](https://d3js.org/)
+* Built with [React.js](https://facebook.github.io/react/), [Redux](https://redux.js.org/)\*\*, [Redux-Saga](https://redux-saga.js.org/)\*\*, [styled-components](https://www.styled-components.com/), [D3.js](https://d3js.org/)
 * Prices retrieved from [Coinbase API](https://developers.coinbase.com/api/v2)
 * Deployed with [Now](https://zeit.co/now)
 
-<p align="center">
-  <img src="./docs/screenshot.png">
-</p>
+*\*\* [Redux](https://redux.js.org/), [Redux-Saga](https://redux-saga.js.org/) is used for learning purposes since it's a slight overkill for this simple app*
 
 ## Installation
 
-Prerequisites: [Node](https://nodejs.org/en/download/) & [npm](https://docs.npmjs.com/getting-started/installing-node) installed on your system.
+**Prerequisites**: [Node](https://nodejs.org/en/download/) & [npm](https://docs.npmjs.com/getting-started/installing-node) installed on your system.
 
 ``` bash
-git clone https://github.com/tohjustin/coincharts.git && cd ./coincharts
+git clone https://github.com/tohjustin/coincharts.git
+cd ./coincharts
 npm install
 ```
 
 You might also want to install [Now](https://zeit.co/now) for deployment
+
 ``` bash
 npm install now-cli -g
 ```
 
 ## Getting Started
 
+**\*\*NOTE\*\*** Make sure you create a `.env` file before proceeding on (see [.env.example](./.env.example) for list of environment variables to populate)
+
 ``` bash
 # Runs the app in development mode at `localhost:3000`
 npm run start
 
-# Takes a snapshot of responses from coinbase API & saves them into JSON files in `public/priceData` (for offline development)
-npm run downloadPriceData
-
 # Create production build in `/build` folder
 npm run build
 
-# Serve production build at `localhost:5000`
-npm run serve
-
 # Deploy app with `now.sh` using configuration defined in `now.json`
-npm run deploy
+npm run script:deploy
+
+# Takes a snapshot of responses from coinbase API & saves them into JSON files in `public/priceData` (for offline development)
+npm run script:downloadPriceData
 ```