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

update readme

Browse Source
This commit is contained in:
Riku Rouvila
2015-01-18 16:20:29 +02:00
parent a65b3c19c2
commit 52306f2a5a
2 changed files with 20 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -1 +1,19 @@
# koodiklinikka.fi API # koodiklinikka.fi API
[ ![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
```
$ 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
```

3
package.json
View File

@@ -4,7 +4,8 @@
"description": "", "description": "",
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1" "test": "echo \"Error: no test specified\" && exit 1",
"start": "node index.js"
}, },
"repository": { "repository": {
"type": "git", "type": "git",