From 0a6705b9387372194b95becc231ae539c1f0e606 Mon Sep 17 00:00:00 2001 From: xdrm-brackets Date: Wed, 17 Oct 2018 17:58:13 +0200 Subject: [PATCH] add v1 readme --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 582af78..45fcc8a 100644 --- a/README.md +++ b/README.md @@ -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`.