Merge pull request #318 from azizur/update-readme

Update readme to help new developers

Author: ahmedre

README.md

@@ -1,51 +1,54 @@
-[![Stories Ready](https://badge.waffle.io/quran/quran.com-frontend.svg?label=ready&title=Ready)](http://waffle.io/quran/quran.com-frontend)
-[![Stories In Progress](https://badge.waffle.io/quran/quran.com-frontend.svg?label=in%20progress&title=In%20Progress)](http://waffle.io/quran/quran.com-frontend)
-[![Stories In Review](https://badge.waffle.io/quran/quran.com-frontend.svg?label=in%20review&title=In%20Review)](http://waffle.io/quran/quran.com-frontend)
 
+# Quran.com
 
-## Quran.com
 This is the project soon to be the Quran.com facing site. This is built in
 Reactjs + Redux + Expressjs + Webpack. It is isomorphic (javascript shared
 between both the server and the client) for SEO reasons.
 
-[![Dependency Status](https://david-dm.org/quran/quran.com-frontend.svg)](https://david-dm.org/quran/quran.com-frontend)
+[![Stories Ready](https://badge.waffle.io/quran/quran.com-frontend.svg?label=ready&title=Ready)](http://waffle.io/quran/quran.com-frontend)
+[![Stories In Progress](https://badge.waffle.io/quran/quran.com-frontend.svg?label=in%20progress&title=In%20Progress)](http://waffle.io/quran/quran.com-frontend)
+[![Stories In Review](https://badge.waffle.io/quran/quran.com-frontend.svg?label=in%20review&title=In%20Review)](http://waffle.io/quran/quran.com-frontend)
+
+
+[![Dependency Status](https://david-dm.org/quran/quran.com-frontend.svg)](https://david-dm.org/quran/quran.com-frontend) [![devDependency Status](https://david-dm.org/quran/quran.com-frontend/dev-status.svg)](https://david-dm.org/quran/quran.com-frontend#info=devDependencies)
 [![Code Climate](https://codeclimate.com/github/quran/quran.com-frontend.png)](https://codeclimate.com/github/quran/quran.com-frontend)
 
-#### Getting started
+## Getting started
 Simply clone this repo, then run `npm install` to install all the required node_modules.
 From there, you are ready to go!
 
-#### Developing
-To start the app, run `npm run dev` which will
-run both the server and the client (webpack) to compile upon edits. Go to localhost:8001 in your browser, not 8000 (that is just the express server).
+## Developing
+Unless you have the backend API running locally, you will need to update the `API_URL`, in `development.env` file, from `localhost` to `api.quran.com`. Leave the port number same.
+
+To start the app, run `npm run dev` which will run both the server and the client (webpack) to compile upon edits. Go to http://localhost:8001 in your browser, not 8000 (that is just the express server).
 
-#### Tests
+## Tests
 Run `npm run test:watch` to run the tests locally and watching. Otherwise use `npm run test` for CI level tests.
 
 We also have nightwatch function tests. You can install nightwatch globally and can run tests like this:
 ```
 nightwatch --test tests/functional/specs/Index_spec.js
 ```
 
-#### Backend
+## Backend
 Current at: https://github.com/quran/quran-api-rails
 DB is private, message me for acceess.
 
-#### How to contribute
+## How to contribute
 Fork this repo, then create a PR for specific fixes, improvements, etc. We trust that
 you will not steal this, this is at the end of the day for the sake of Allah and we
 all have good intentions while working with this project. But I must stress, stealing
 this is unacceptable.
 
-#### Design
+## Design
 We currently use InvisionApp. Again, contact me if you'd like access to it.
 
-#### Making sure main.js is small
+## Making sure main.js is small
 Follow: https://www.npmjs.com/package/webpack-bundle-size-analyzer
 ```
 env NODE_ENV=development webpack --json > bundle-stats.json
 subl bundle-stats.json #so that you can the output
 analyze-bundle-size bundle-stats.json
 ```
 
-###### [View project issues on waffle.io...](https://badge.waffle.io/quran/quran.com-frontend)
+## [View project issues on waffle.io...](https://badge.waffle.io/quran/quran.com-frontend)