PMS API

PMPS API is a population management system. It helps its users perform CRUD operation on locations.

Getting Started

Clone the repository

$ git clone git@github.com:gbengaPS/pmsAPI.git

Change directory into the project

$ cd pmsAPI

Then install packages

$ npm install

Change .env.sample to .env and add the needed values

Start application

$ npm start

Endpoint	HTTP Method	Description
/api/v1/locations	GET	Returns all locations with their child up to one level deep
/api/v1/user	POST	Creates a new user
/api/v1/user/login	POST	Generates user access token
/api/v1/location	POST	Creates new location. This route requires an access token
/api/v1/location/:id	PATCH	Updates a particular location. Another protected route
/api/v1/location/:id	DELETE	Delete a location. This action can only be performed by the user with an admin role

####Note:

Only an admin can delete a location
Admin credentials are added to the database upon a successful migration
There is currently no way to upgrade a user to admin level.
Except for create user and user login, all other routes are protected and need the Authorizatio header to be set.
Token is generated upon login

Visit API DOC for API documentation

This application was built with Node js so you'll need the following to get it up and running

Jest is the test framework used for this project To run tests

$ npm run test

To see test coverage

$ npm run test:cover