diff --git a/README.md b/README.md index 7abfbca..88e8cff 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,25 @@ This is the `API` for the `YouCanBenefit` project. -It has two accessible routes: +# service dependencies +* [elasticsearch](https://www.elastic.co/products/elasticsearch) +* [install tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-elasticsearch-on-ubuntu-16-04) + +# setup +* `npm run prestart:prod` +* `npm run start:prod` + * one should use a process management tool +* `http get localhost:3000/data/init` + * this will create and map required elasticsearch indices + + +--- + +It has three accessible routes: * `/protected/...` * `/api/...` +* `/data/...` There is no authentication service provided. diff --git a/package.json b/package.json index 6c4f337..2b42f88 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "description": "Nest TypeScript starter repository", "license": "MIT", "scripts": { - "start": "node index.js", + "start": "nodemon", "start:watch": "nodemon", "prestart:prod": "tsc", "start:prod": "node dist/server.js",