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

add v1 readme

This commit is contained in:
Adrien Marquès 2018-10-17 17:58:13 +02:00
parent 958e0134a0
commit 0a6705b938
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,2 +1,28 @@
# api-mixer.js # | API mixer |
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
##### 1. Transpile sources
> You need to install `typescript`, it will automatically install its compiler (_i.e. tsc_) into your environment path. You can easily install it globally with `npm -g i typescript`.
Then launch the following command inside the project's folder :
```bash
$ tsc
```
##### 2. Launch server
> You need to have `node` installed.
Launch the server with the following command (inside the project's folder) :
```bash
$ node main.js
```
##### 3. Test the API
Simply use [Postman](https://www.getpostman.com/) or whatever API client at `127.0.0.1:8000`.