Skip to content

Latest commit

 

History

History
172 lines (127 loc) · 5.24 KB

README.md

File metadata and controls

172 lines (127 loc) · 5.24 KB
Raw

Backend API using Nest Framework

This project is a backend API built with Nest framework in TypeScript. It utilizes MySQL as the database and Prisma as the ORM. Docker is used for deployment.

Overview

The API calculates salary rates based on monthly and daily rates. It considers the number of days after the payment date or a specific daily date and the number of days for the daily salary rate.

Technologies Used

Installation

$ yarn install

Running the app

Start MySQL docker fist

docker-compose up -d mysql-db
# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Test

# unit tests
$ yarn run test

# test coverage
$ yarn run test:cov

Docker Test Environment

Prerequisites

  • Docker installed on your machine.

Setting Up Docker Test Environment

  1. Clone the repository:
git clone https://github.com/shatshai/salary-backend-api
cd salary-backend-api
  1. Build and start the Docker containers
docker-compose up -d mysql-db # Make sure MySQL is running
docker-compose up -d --build

Testing the Backend API

  • Once the Docker containers are running, you can test the backend API by sending HTTP requests to http://localhost:3000/sawgger using tools like cURL, Postman, or your browser.

Stopping the Docker Containers

docker-compose down

Endpoints

Company

  • GET /company: Retrieves a list of all companies.

  • POST /company: Creates a new company.

  • GET /company/:id: Retrieves details of a specific company.

  • PUT /company/:id: Updates details of a specific company.

  • DELETE /company/:id: Deletes a specific company.

Employee

  • GET /employee: Retrieves a list of all employees.

  • POST /employee: Creates a new employee.

  • GET /employee/:id: Retrieves details of a specific employee.

  • PUT /employee/:id: Updates details of a specific employee.

  • DELETE /employee/:id: Deletes a specific employee.

Swagger Api Document

  • GET /swagger: List the APIs document.

Screen short

Alt text

Libraries

  • @nestjs/swagger: A library that integrates Swagger (OpenAPI) with NestJS, allowing for automatic API documentation generation and interactive API exploration.
  • Helmet: Middleware for securing NestJS applications by setting HTTP headers for enhanced security, including protection against common web vulnerabilities.
  • @prisma/client: Prisma's official client for interacting with your database, providing a type-safe and auto-generated query builder for efficient database operations.
  • prisma: Prisma's CLI tool for managing database migrations, generating Prisma client code, and performing various database-related tasks seamlessly.

Database Schema

Table Name Columns Relationships
Company id, name, address One-to-Many with Employee
Employee id, username, email, companyId, Many-to-One with Company
salary, salaryTypeId, payDate
  1. Company Table:
  • Columns:
    • id: Integer, Primary Key, Autoincrement
    • name: String
    • address: String
  • Relationships:
    • One-to-Many with Employee table (employees field)
  1. Employee Table:
  • Columns:
    • id: Integer, Primary Key, Autoincrement
    • username: String
    • email: String
    • companyId: Integer, Foreign Key (company_id), References Company(id)
    • salary: Float
    • salaryTypeId: Integer, Foreign Key (salary_type_id), References SalaryType(id)
    • payDate: Integer, Default 1 (map to pay_date)
  • Relationships:
    • Many-to-One with Company table (company field)

Database Schema Description

  • Company Table:
    • Stores information about companies.
    • Includes fields for id, name, and address.
  • Employee Table:
    • Holds details about employees.
    • Includes fields for id, username, email, salary, payDate (defaulted to 1), and foreign keys for companyId and salaryTypeId.
    • Establishes relationships with Company (many employees belong to one company) and SalaryType (each employee has a salary type).

Salary Types for Employees

Enum Definitions

We're using constants to store employees' salary types instead of a data table for a single source of truth.

// Enum defining different salary types
export enum SalaryTypes {
  DAILY = 1, // Salary calculated on a daily basis
  MONTHLY = 2, // Salary calculated on a monthly basis
  MONTH_TO_DATE = 3, // Salary calculated from the start of the month to the current date
}

// Salary Types Description
export const SalaryTypesDescription = {
  [SalaryTypes.DAILY]: 'Daily rate',
  [SalaryTypes.MONTHLY]: 'Monthly rate',
  [SalaryTypes.MONTH_TO_DATE]: 'Monthly rate with payment date',
}

License

Nest is MIT licensed.