README.md

Employee management REST API

Here is a list of all API Endpoints that you will find:

• POST /api/v1/signup
• GET /api/v1/verify For better result please copy the link and paste it in browser or simply use postman
• POST /api/v1/login
• POST /api/v1/employees
• DELETE /api/v1/employees/:id
• PUT /api/v1/employees/:id
• PUT /api/v1/employees/:id/active
• PUT /api/v1/employees/:id/suspend
• POST /api/v1/employees/search

Technology tools used in this Project

• Server side Framework : Node/Express
• Linting Library: ESLint
• Style Guide: Airbnb
• Testing Framework: Mocha
• Database: Postgresql
• Hosting API: Heroku

Additional Tools

• JavaScript Es6 with Babel compiler
• TravisCI for Continous Integration
• nyc for test coverage

Here there is important link you may visit

• Employees Management Here is link for APIs EndPoints
• For a better test you will need to use POSTMAN

Setup project locally

• Install git
• Install Node js
• Clone Repo TaskForceAPI

$ To move into folder

$ cd TaskForceAPI

Install dependincies as they appear in package.json file by

$ npm install

To start the server do

$ npm run dev-start

To run the test do

$ npm run test

Author

Kevin KIMENYI

Acknowledgments

Awesomity Task Force