ngaboindev / employee-management

Awesomity taskforce 4.0 backend challenge

TaskForce challenge 4.0 backend

a Restful API for an employee management system

SETTING UP ENVIRONMENT

$ brew install node

check if it's available

$ node -v

Check if you have git client

$ git --version

Now clone repo

$ git clone https://github.com/ngaboindev/taskforce-backend-challenge.git

Usage

Rename ".env.example" to ".env" and update values/settings to your own

Install dependencies

with npm

npm install

Test app

with npm

npm test

Start local server

 $ npm run dev

DOCUMENTATION

API DOC available here : https://empmanagementapi.herokuapp.com/documentation/v1

API ENDPOINTS

BASEURL: /api/v1

AUTHENTICATION END POINTS : /auth/

HTTP METHOD	END POINT	DESCRIPTION
POST	/auth/register/manager	Create a New Manager
POST	/auth/login/manager	Authenticate Manager
POST	/auth/confirm/:confirmToken	Confirm Email sent to Manager's email
POST	/auth/forgotpassword	Reset the password by providing an email address to get rest link
POST	/auth/resetpassword/:resettoken	Link to reset password by providing new password for Manager

EMPLOYEE FEATURES END POINTS (ACCESS : MANAGER ONLY) : /employee/

HTTP METHOD	END POINT	DESCRIPTION
GET	/employee?code=EMP321&position=developer	search employee based on position,name,code,phone
POST	/employee	Create a New Employee
PUT	/employee/:id	Update Employee Infos
DELETE	/employee/:id	Delete Employee
PUT	/employee/:id/suspend	Suspend an employee.
POST	/employee/:id/activate	activate an employee

Things i wish i've done if i had more time

• unit & integration tests
• finishing documentation
• doing CD/CI

Author

Robert Ngabo <[e-mail]>