Employer is a management system used by manager in an organization to keep track of their employees;
- Manager can create an account.
- Manager can sign in.
- Manager can add a new employee.
- Manager can edit an employee.
- Manager can remove an employee.
- Manager can suspend or activate an employee.
- Manager can search an employee based on their position, name, email or phoneNumber.
- NodeJS - JavaScript Runtime Environment
- ExpressJs - A Minimal Web Application Framework
- PostgreSQL - a free and open-source relational database management system
Ensure you have NodeJS installed on your computer by entering node -v on your terminal. If you don't have NodeJS installed go to the NodeJS Website, and follow the download instructions
Clone the app
git clone https://github.com/nraufu/employer.git
Install all the packages
npm install
Run the server
npm start
Run Test case
npm run test
Test Api
| Endpoint | Functionality |
|---|---|
| PUT /employees/:id/activate | activate employee |
| PUT /employees/:id/suspend | suspend employee |
| PUT /employees/:id | edit employee |
| POST /employees/:id | search Employees based on |
| name, email or position | |
| POST /employees | add employee |
| DELETE /employees/:Id | Remove an employee |
| POST /auth/signup | Manager Register |
| POST /auth/login | Manager Login |