koodiklinikka/koodiklinikka.fi-api
1
0
Fork 0
mirror of https://github.com/koodiklinikka/koodiklinikka.fi-api.git synced 2026-01-26 03:34:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(README) improve document structure

Browse Source 
- Improve document structure to make it more readable.
- Indent code snippets so that they get displayed properly.
This commit is contained in:
Daniel Schildt
2017-07-05 15:14:25 +03:00
committed by GitHub
parent cdc9b5a141
commit d2fe53b3e6
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -3,17 +3,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) [ ![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 ### Start developing
* Install node.js * 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 $ git clone git@github.com:koodiklinikka/koodiklinikka.fi-api.git
$ npm install $ 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. * 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. 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. `all` block is always used and the block selected is merged into it so that it overwrites the values defined in it.
* ``` * Start the development environment.
$ npm start ```
``` $ npm start
```