https://github.com/web2solutions/payroll-service
Simple payroll service
https://github.com/web2solutions/payroll-service
concurrency javascript nodejs payroll redis sequelize transaction
Last synced: about 2 months ago
JSON representation
Simple payroll service
- Host: GitHub
- URL: https://github.com/web2solutions/payroll-service
- Owner: web2solutions
- Created: 2023-12-27T15:33:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T16:07:13.000Z (about 2 years ago)
- Last Synced: 2025-03-29T13:12:31.601Z (about 1 year ago)
- Topics: concurrency, javascript, nodejs, payroll, redis, sequelize, transaction
- Language: JavaScript
- Homepage:
- Size: 3.26 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simple Payroll Service
This project is as POC and is organized as a monorepo that coordinates a [backend](./backend) and a [frontend](./frontend) project.
The main purpose is to mitigate a locking mechanism for concurrent requests to vertical scaled node.js application.
The [backend](./backend) is a REST API with some different end points and the [frontend](./frontend) is consuming that API.
`Project status:` in progress
## Tech debits
[Tech debits](./TECH-DEBITS.md)
## Application stacks
### Backend
- Javascript
- Express
- Express Parser
- Sequelize
- SQLite
- Redis
### Frontend
- React
- Context API
- fetch API
- Bootstrap css
### Project tooling
- Git
- Eslint
- Husky
- Commitizen
- npm
- Docker
- Jest
- Supertest
## Testing
Due the time limitation, actually only the [backend](./backend) have a [test suite](./backend/test/integration/).
Rather than to write unit tests to cover the application, I decided to implement integration tests.
To test the backend application you need to navigate to it folder through your terminal in prior.
```bash
$ cd backend
```
***`Note1:` Do not start the API to test it.***
***`Note2:` Delete the file `/backend/database.sqlite3`, if it exists, before running the tests .***
Now you can run the test suite:
```bash
$ npm test
```
## How to run the application?
If you don't have Docker then you can manual run it.
### Manually running the applications
It is recommended to have at least the version `18` of `Node.js`.
You will need to have [Redis](https://redis.io/docs/install/install-redis/) installed to manual run the application
#### Install
To get able to reach the frontend application and see it running integrated with the backend, you need to install it prior.
```bash
$ npm run install:all
```
***Please do not run `npm install` because it will not install both projects.***
#### Run the applications.
This project offers a command that concurrently starts both applications.
```bash
$ npm start
```
Now you can reach it through your preferred browser by accessing `http://localhost:3000/`.
### Running the applications with Docker
1. install the tooling
```bash
$ npm install
```
2.
```bash
$ npm run docker
```
Once the containers are started, you can reach it through your preferred browser by accessing `http://localhost:3000/`.