Skip to content

README.md

Latest commit

 

History

History
63 lines (39 loc) · 1.17 KB

README.md

File metadata and controls

63 lines (39 loc) · 1.17 KB

User API web application

It is a basic NodeJS web application exposing REST API that creates and stores user parameters in Redis database.

Functionality

  1. Start a web server
  2. Create a user

Installation

This application is written on NodeJS and it uses Redis database.

  1. Install NodeJS

  2. Install Redis

  3. Install application

Go to the root directory of the application (where package.json file located) and run:

npm install

Usage

  1. Start a web server

From the root directory of the project run:

npm start

It will start a web server available in your browser at http://localhost:3000.

  1. Create a user

Send a POST (REST protocol) request using terminal:

curl --header "Content-Type: application/json" \
  --request POST \
  --data '{"username":"sergkudinov","firstname":"sergei","lastname":"kudinov"}' \
  http://localhost:3000/user

It will output:

{"status":"success","msg":"OK"}

Another way to test your REST API is to use Postman.

Testing

From the root directory of the project, run:

npm test