This is the server-side of a project made using the MERN stack. The website can be accessed at https://companyxweb.netlify.app, and the client-side repository can be found at https://github.com/Sidharthkp/CompanyX-Client-.git. The project mainly focuses on three modules, which include Admin, Employee, and HR.
- The Admins can view the Dashboard which handles all the datas infographically.
- Admins can post the banner and delete the banner.
- Admins can block/unblock users who is loging in to the website.
- Admins can also view the salary details of the employees.
- HR is the one who generates salary slips to employees.
- HR can view all salaries provided to each employees.
- Employee can view and export the data (salary slip).
- All the salary slips can be accessed by just searching the date of salary issued in the search bar.
To install and run this project, follow these steps:
- Clone this repository:
git clone https://github.com/Sidharthkp/CompanyX-Server-.git - Navigate to the project directory:
cd CompanyX-Server- - Install the dependencies:
npm install - Create a
.envfile in your root folder and create the key value pair for connection to the MongoDB database eg:MONGO_URL: "mongodb+srv://: xyz.mongodb.net/?retryWrites=true&w=majority" - And provide some dummy datas for user login which holds the user details:
Create a collection named
userand import the json fileusers.jsonwhich is provided inside the project directorycd /public/userCollection - Run the project:
npm run dev
If you have any questions or comments about this project, please email me at sidharthkannan20@gmail.com.
API documenation link - https://documenter.getpostman.com/view/24147495/2s93CLtEHw