diff --git a/README.md b/README.md index 25fc9e4..06b0925 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@ # 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 +``` \ No newline at end of file diff --git a/package.json b/package.json index 12ccc84..06b1e7a 100644 --- a/package.json +++ b/package.json @@ -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",