mirror of
https://github.com/koodiklinikka/koodiklinikka.fi-api.git
synced 2026-01-26 11:44:12 +00:00
d2fe53b3e6
- Improve document structure to make it more readable. - Indent code snippets so that they get displayed properly.
21 lines
1.0 KiB
Markdown
21 lines
1.0 KiB
Markdown
# koodiklinikka.fi API
|
|
|
|
[ ](https://codeship.com/projects/57155)
|
|
|
|
### Start developing
|
|
* 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.
|
|
|
|
* Start the development environment.
|
|
```
|
|
$ npm start
|
|
```
|