mirror of
https://github.com/koodiklinikka/koodiklinikka.fi-api.git
synced 2026-01-26 03:34:03 +00:00
update readme
This commit is contained in:
18
README.md
18
README.md
@@ -1 +1,19 @@
|
||||
# koodiklinikka.fi API
|
||||
|
||||
[ ](https://codeship.com/projects/57155)
|
||||
|
||||
### Start developing
|
||||
* Install node.js
|
||||
```
|
||||
$ 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.
|
||||
|
||||
* ```
|
||||
$ npm start
|
||||
```
|
||||
@@ -4,7 +4,8 @@
|
||||
"description": "",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"test": "echo \"Error: no test specified\" && exit 1"
|
||||
"test": "echo \"Error: no test specified\" && exit 1",
|
||||
"start": "node index.js"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
|
||||
Reference in New Issue
Block a user