From 24db86c7f562d3093c605c3ae23e05562b0b5dfd Mon Sep 17 00:00:00 2001 From: xdrm-brackets Date: Mon, 22 Oct 2018 17:52:29 +0200 Subject: [PATCH] update readme --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3a04543..100995f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Simple REST API mixer as a service. A minimal service will be deployed on your local port `8000`, all incoming data has to be sent by _POST_ fields (_e.g. [form-data](https://tools.ietf.org/html/rfc2388), [x-www-form-urlencoded](https://www.w3.org/TR/html5/sec-forms.html#urlencoded-form-data)_). The output is a _application/json_ set. -### Launch the project +### Project Set up ##### Prerequisites @@ -36,8 +36,14 @@ Launch the server with the following command (inside the project's folder) : $ node dist/main.js ``` -Also, a shorthand is `npm start`. +### Project fast start -##### 3. Test the API +This command will build and run the whole project : +```bash +$ npm run build; +$ npm start; +``` -Simply use [Postman](https://www.getpostman.com/) or whatever API client at `127.0.0.1:8000`. +### Test the API + +You can now use [Postman](https://www.getpostman.com/) or whatever API client at `127.0.0.1:8000`.