Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/n2duc/integration-hr-payroll
CMU-CS 445 System Integration Practices DTU Course
https://github.com/n2duc/integration-hr-payroll
Last synced: about 13 hours ago
JSON representation
CMU-CS 445 System Integration Practices DTU Course
- Host: GitHub
- URL: https://github.com/n2duc/integration-hr-payroll
- Owner: n2duc
- Created: 2024-04-10T12:16:50.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-20T07:55:38.000Z (6 months ago)
- Last Synced: 2024-05-20T08:56:38.711Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 85 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
`N2D`
# HR & Payroll Dashboard (SERVER)
A centralized dashboard application for managing HR and Payroll data, built using Node.js, Express.js, and Sequelize.
## Features
* **Employee Management:** View, add, edit, and manage employee profiles from the HR database.
* **Payroll Processing:** Calculate salaries, generate payslips, and track payroll history from the Payroll database.
* **Reporting:** Generate customizable reports on HR and payroll metrics.
* **Dashboard Interface:** Intuitive and user-friendly interface to visualize data.
## Installation
1. **Clone the repository:**
```bash
git clone https://github.com/n2duc/integration-hr-payroll
```
2. **Install dependencies:**
```bash
cd integration-hr-payroll
npm install
```
## Configuration
1. **Create a `.env` file in the project root:**
```
PORT =
# Sql Server
MSSQL_HOST =
MSSQL_PORT =
MSSQL_USER =
MSSQL_PASSWORD =
MSSQL_NAME =
# Mysql
MYSQL_HOST =
MYSQL_PORT =
MYSQL_USER =
MYSQL_PASSWORD =
MYSQL_NAME =
```
2. **Update Sequelize models:**
* Modify models in the `models` directory to reflect your HR and Payroll database schemas.
## Running the Application
1. **Start the development server:**
```bash
npm start
```
2. **Access the api:**
```bash
[GET] http://localhost:8080/api/employees
[POST] http://localhost:8080/api/employees
[GET] http://localhost:8080/api/employees/1
[PUT] http://localhost:8080/api/employees/1
[DELETE] http://localhost:8080/api/employees/1
[GET] http://localhost:8080/api/vacations
[GET] http://localhost:8080/api/incomes
[GET] http://localhost:8080/api/benefits
[GET] http://localhost:8080/api/alert/birthday
[GET] http://localhost:8080/api/alert/excess-vacation
[GET] http://localhost:8080/api/alert/anniversary
```
## Contributing
We welcome contributions to improve this project! Please follow these guidelines:
* **Create an issue:** Describe the feature or bug fix you wish to implement.
* **Fork the repository.**
* **Create a branch:** Name it descriptively (e.g., `employee-search-feature`).
* **Implement your changes.**
* **Submit a pull request.**
## License
This project is licensed under the MIT License – see the [LICENSE.md](LICENSE.md) file for details.
**Important Notes**
* Replace placeholder database names, credentials, and dialects with your actual database information.
* Ensure that `mysql` or other relevant database drivers are installed (`npm install mysql2` or similar).
* Adapt this structure as your project evolves, providing more detailed setup, usage, and development instructions.
Let me know if you want me to expand on specific parts or add more features!