Employee-management-API

A REST API to manage your employees easily and with bulk add employees and specific employee tracking.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on your own live system.

Prerequisites

You need to have:

• NodeJs Runtime if not download it here
• PostgreSQL Database if not download it here
• Git Version Control if not download it here

To check The Prerequisites are installed you can use these terminal commands:

For NodeJs: node --version

For Postgres: psql --version

For Git: git --version

Installing

A step by step series of examples that tell you how to get a development env running

Clone the Repo with the terminal command:

git clone https://github.com/RedJanvier/Employee-management-API.git

then make a file called .env using sample.env by replacing with your own data.

Run the command inside the cloned directory:

npm install

To start the app in development run the command:

npm run dev

Built With

• NodeJS - The javascript runtime used
• ExpressJS - The web framework used
• NPM - Dependency Management
• PostgreSQL - Database system used
• Sequelize - Database management system (DBMS) used
• NodeMailer - Email client system used

Author

• RedJanvier - uzakuraHub - RedJanvier

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Documentation

The documentation of full endpoints and all the requirements can be found at the root endpoint of the API or here