diff --git a/README.md b/README.md index 6f752d2..c38a9fb 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,18 @@ [ ![Codeship Status for koodiklinikka/koodiklinikka.fi-api](https://codeship.com/projects/5ba71cf0-7f0a-0132-b32d-661179cb74c9/status?branch=master)](https://codeship.com/projects/57155) -### Start developing -* Install node.js & install dependencies -``` -$ git clone git@github.com:koodiklinikka/koodiklinikka.fi-api.git -$ cd koodiklinikka.fi-api -$ npm install -``` +* Install [Node.js](https://nodejs.org/en/) with your preferred installation method. +* Clone the repository and install dependencies. + ``` + $ git clone git@github.com:koodiklinikka/koodiklinikka.fi-api.git + $ cd koodiklinikka.fi-api + $ npm install + ``` +* Create `config.json` file. See [config.template.json](https://github.com/koodiklinikka/koodiklinikka.fi-api/blob/master/config.template.json) for possible options. +The config file consists of environment specific blocks. Environment variable `NODE_ENV` determines which block is used. If the environment variable is not present, the `development` block will be selected. +`all` block is always used and the block selected is merged into it so that it overwrites the values defined in it. --* Create `config.json` file. See [config.template.json](https://github.com/koodiklinikka/koodiklinikka.fi-api/blob/master/config.template.json) for possible options. --The config file consists of environment specific blocks. Environment variable `NODE_ENV` determines which block is used. If the environment variable is not present, the `development` block will be selected. --`all` block is always used and the block selected is merged into it so that it overwrites the values defined in it. - -### Run development environment - -* ``` $ npm start ``` - -Now app will be running on `localhost:9000`. \ No newline at end of file +* Start the development environment. + ``` + $ npm start + ```