update readme
This commit is contained in:
parent
678fcdcb12
commit
24db86c7f5
14
README.md
14
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`.
|
||||
|
|
Loading…
Reference in New Issue