mti
/
api-mixer
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update readme

This commit is contained in:
Adrien Marquès 2018-10-22 17:52:29 +02:00
parent 678fcdcb12
commit 24db86c7f5
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -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. 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 ##### Prerequisites
@ -36,8 +36,14 @@ Launch the server with the following command (inside the project's folder) :
$ node dist/main.js $ 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`.