Employee Managment Rest API

Table of contents

• Employee Managment Rest API
  • Table of contents
  • General Info
  • Technologies used
  • Local Project Setup(For Dev purposes)
  • Features
    • Implemented
    • To Be Implemented
  • Available Endpoints
  • Documentation
  • Status
  • CopyRights

General Info

Employee Managment API is a collection of enpoint that facilitate,
the managment of employees at managerial point of view

Technologies used

• Nodejs
• ExpressJs
• ES6
• HandleBars
• Postman

Local Project Setup(For Dev purposes)

• clone the project using git clone https://github.com/kwizeraelvis/EmployeeManagmentRestAPI.git
• move into the source directory using cd EmployeeManagmentRestAPI
• install all neccesary dependencies/modules using yarn install or with npm using npm install
• build the source using yarn run build or with npm using npm run build
• start the server using yarn run start or with npm using npm run start

Features

Implemented

• Managers can create an employee
• Managers can update an employees profile
• Manager can activate the employee
• Managers can suspend an employee
• Managers can list all available employees
• Managers can view employees by their id
• Manager can delete an employee
• Manager can search any employee
• Manager can upload excel workbooks containg employee Information and they will be registered

To Be Implemented

• [] Manager signup
• [] Manager Signin
• Sending Email confirmation to Employee upon registration(Implemented + deployed)
• [] Manager Password Reset
• [] User Activity
• Heroku Deployment(Implemented + deployed)
• Add validation to data from excel worksheets(Implemented + deployed)

Available Endpoints

Endpoint	Method	Functionality
/employees	POST	Create New Employee
/employees/search	POST	Search an Employee by props
/batchcreate	POST	Parses excel files and registers employees listed
/employees/:id	PUT	Updates employees profile
/employees/:id/activate	PUT	Updates employee status to active
/employees/:id/suspend	PUT	Updates employee status to inactive
/employees/:id	DELETE	Deletes an employee by their id
/employees/list	GET	Lists all registered employees
/employees/:id	GET	Shows employee profile by id
/file	GET	Is used to render the file upload template

Documentation

Documentation can be found here: []

Status

In development

CopyRights