Merge pull request #44 from Code4Nepal/42_np

doc: update README #42

README.md

@@ -42,7 +42,7 @@ Please provide feedbacks here - https://goo.gl/forms/XfIMqXmRMp3MMMMh2 . For bug
 
 ## Development Notes
 
-We use docker during development as well as for production use.
+We use docker during development as well as for production use. If you're only working on front-end components, you do not need to set up docker environment. See the frontend specific docs [parijat-frontend-docs](parijat-frontend/README.md)
 
 Please follow the official docs to install [docker](https://docs.docker.com/install/) and [docker-compose](https://docs.docker.com/compose/install/) on your system.
 
@@ -59,7 +59,7 @@ There's also a nginx service that acts as a reverse proxy to the core services,
 
 #### Notes
 
-* You will need to prefix the docker commands with *sudo*, if you haven't added your user to the *docker* group.
+* You will need to prefix the docker commands with *sudo*, if you haven't added your user to the *docker* group (https://docs.docker.com/install/linux/linux-postinstall/). 
 
 * If you are a developer running the elasticsearch instance here for testing, please read through the elasticsearch-specific [akshara docs](elasticsearch/README.md), especailly the [usage](elasticsearch/README.md#usage) section. Our elasticsearch setup makes certain assumptions that you need to follow while indexing documents, to ensure that all search features are available.
 

parijat-frontend/README.md

@@ -1,21 +1,59 @@
-# पारिजात 
+# Sangraha Frontend
 
-Super performant `Material` app for preact world using [preact-material-components](https://github.com/prateekbh/preact-material-components)
+Sangraha frontend is a single page application created using Preact. Preact is a lightwright React alternative. 
 
-## CLI Commands
+## Development Instructions
 
-``` bash
-# install dependencies
+### Pre-requisites
+
+Node.js is required to develop the frontend. To install Node.js and npm (Node Package Manager) either follow the [official instructions](https://nodejs.org/en/) or [use nvm](https://github.com/creationix/nvm). 
+
+#### Using nvm
+
+Install `nvm` following the instructions here [nvm installation](https://github.com/creationix/nvm).
+
+Then install the stable version of `node` and `npm`. At the time when this was written the `LTS` version for Node was `8.12.0`.
+
+```bash
+nvm install 8.12.0
+```
+
+### Install Dependencies
+
+Head to the directory where this README.md file is located and install all development dependencies using npm:
+
+```bash
 npm install
+```
+
+This downloads all the dependencies locally in `node_modules` directory.
 
-# serve with hot reload at localhost:8080
+
+### Start Development Server
+
+Start the development server using the following command:
+
+```bash
 npm run dev
+```
+
+This will start local development server at `localhost:8080` . The development server has hot-reloading enabled and any changes reflect in the browser once the files are saved.
+
 
-# build for production with minification
+### Build for production
+
+To build the application for deployment (minified static files), use the following:
+
+```bash
 npm run build
+```
 
-# test the production build locally
+### Start Production Server
+
+```bash
 npm run serve
 ```
 
-For detailed explanation on how things work, checkout the [CLI Readme](https://github.com/developit/preact-cli/blob/master/README.md).
+## Preact-CLI
+
+The frontend was bootstrapped using Preact-CLI. For further instructions, and detailed explanation on how things work, checkout the [CLI Readme](https://github.com/developit/preact-cli/blob/master/README.md).