salary-hero-backend

KO | EN

gitlite — search

#javascript #python #react #typescript #golang #go #android #docker #macos #windows #vue #security #mcp #openai

salary-hero-backend

(★ 18)

Salary Payment Project

salary-hero-backend 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest

# Salary Hero Backend

## Description

Salary payment project support partner register, config and manage their worker account, 
their worker salary and formula. From that, worker salary will be calculated
automatically every day, every month and worker can manage 
their money.

## Design
### Basic High Level Design Overview
![alt text](https://github.com/matthew-nguyen-20032023/salary-hero-backend/blob/dev/docs/images/overview-system/high-level-design.png?raw=true)
### Low Level Design With AWS Cloud
![alt text](https://github.com/matthew-nguyen-20032023/salary-hero-backend/blob/dev/docs/images/overview-system/low-level-design-with-aws-cloud.png?raw=true)

## Required
Node version v16.20.1 
Yarn version 1.22.19 
Docker version 20.10.21, build 20.10.21-0ubuntu1~22.04.3 
docker-compose version 1.29.2, build unknown 
PM2 version 5.3.0 => Only for Quick Start
## Quick Start Or Manual Setup Guide Below
```bash
# Make sure you have full required above
# Important: make sure that list port here available on your machine
# List port: 9092, 6379, 5432, 2181, 3000, 3001
# Or you can change value from .env.example for another port
$ sudo chmod -R 777 ./quick_start.sh 
$ ./quick_start.sh 
```

## Manual Setup
### Setup components
```bash
# Preparing
$ yarn                          # install lib dependencies
$ cp .env.example .env          # init .env file (change information if you want to) 
$ docker-compose up -d          # init services component (depend on .env file, noted new docker version run docker compose up -d)
$ yarn build                    # build migration file to migrate
$ npm run typeorm:run           # migrate database schema
$ npm run typeorm:test          # migrate testing database schema
$ yarn console:dev seeding-data # seeding data for develop
```
### Run Backend
```bash
# For development run
$ yarn start:dev 
#-----------------------------#
# Or for production run
$ yarn build
$ yarn start:prod
```
### Background Job Handle worker salary calculation 
```bash
# For development run
$ yarn console:dev calculate-worker-salary
#-----------------------------#
# For production run
$ node dist/src/console.js calculate-worker-salary
```

### Note
After full setup and seeding data, we have some account seeded 
AdminAccount: admin@gmail.com 
PartnerAccount: partner@gmail.com 
WorkerAccount: worker@gmail.com 
Password for all: admin@123 
API Swagger: http://localhost:3000/api/docs/

### Testing
```bash
$ yarn test
```

## Some Feature Can Implement In The Future
- OTP to withdraw or transfer money for worker

## Repository Activity
![Alt](https://repobeats.axiom.co/api/embed/1929095ae8b4fb2d5d5dbc561ad4e906db6dd2b7.svg "Repobeats analytics image")
## License

Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).

salary-hero-backend

salary-hero-backend 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

salary-hero-backend

salary-hero-backend 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README