Serum-Bank API

Technologies

Description

This project is a serum bank management system developed with the NestJS framework and TypeORM. The system is responsible for managing and processing serum samples in a database, including the creation, updating, and querying of information about serums and their positions.

Steps to Run the Project:

Environment

Create a .env file in the root of the project following the template below:

Email Configuration

• EMAIL_HOST=smtp.gmail.com
• EMAIL_USER=leo@email.com
• EMAIL_PASS=xxsaZAE2x

Database Configuration

• DB_USERNAME=root
• DB_PASSWORD=root
• DB_DATABASE=SQL_LITE
• DB_DATABASE_TEST=SQL_LITE_TEST

Node Environment

• NODE_ENV=development
• APP_PORT=3000

JWT Secret

• JWT_SECRET=secretKey
• JWT_EXPIRES_IN=1800s

Command to Run Tests

npx jest

Commands to Run the Project

Open the terminal and run these commands:

• Start the app with docker

docker compose up

• Without docker:

Dependencies

Open the terminal and run the following command:

npm install

• Run the NestJS application

npm run start:dev

Default User

• email: admin@admin.com
• password: admin

Documentation

To view the API documentation, access:

http://localhost:3000/api#/

Front-end Example