From 5316c9638bdbcc6508817585e75f2c7a88ba5a4c Mon Sep 17 00:00:00 2001 From: Aqeeb Imtiaz Harun Date: Fri, 10 Aug 2018 11:49:19 +0800 Subject: [PATCH] updated readme with installation and usage --- readme.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index a7fdf1a..95e6160 100644 --- a/readme.md +++ b/readme.md @@ -4,10 +4,10 @@ We will be using JSON Server + JWT Auth for this project's login functionality. (Later further updates will be added.) ## Prerequisites -- [Node.js & NPM](https://nodejs.org/en/download/) -- Postman +- [Node.js & NPM](https://nodejs.org/en/download/). +- [Postman Software](https://www.getpostman.com/) to test the API. -### Login +### Installation Run the following command first. @@ -16,8 +16,9 @@ $ npm install $ npm run start-auth ``` +### Usage On Postman, navigate to http://localhost:3000/auth/login and use x-www-form-urlencoded/JSON with 'phone' and 'password' fields. User details can be found in users.json. -Follow [this link](https://www.techiediaries.com/fake-api-jwt-json-server/) [or this link](https://github.com/techiediaries/fake-api-jwt-json-server) for further details. +Follow [this](https://www.techiediaries.com/fake-api-jwt-json-server/) or [this](https://github.com/techiediaries/fake-api-jwt-json-server) for further details.