Read in another language: Ukrainian.
This repository contains a backend API project for user registration and authorization using JWT, along with role management and access control.
- Project overview
- Technologies used
- API Documentation
- Requirements
- Installation
- Configuration
- Server Commands
- REST API
- registration/authorization JWT
- user roles and their verification
- database PostgreSQL + Sequilize
- working with the file system
- documentation API
- develop/production configuration
- data validation
- Docker/docker-compose
NestJS Sequelize JWT (JSON Web Token) bcryptjs Swagger TypeScript ESLint Prettier Jest RxJS class-transformer class-validator Multer
For detailed descriptions of API requests and interactions, refer to the https://localhost:5000/api/docs
Before getting started with the project, make sure you have the following tools installed on your computer:
- Node.js (version 14 or higher)
- Clone this repository to your local computer.
- Open the terminal and navigate to the root folder of the project.
- Run the command
npm installto install project dependencies.
- Create a .env file in the project's root folder, based on the .env.example file.
- Specify the necessary environment variables in this file.
npm:
npm start— Start the server in production mode.npm run start:dev— Start the server in development mode.npm run lint— Run code linting using eslint. Perform this before each PR and fix all linting errors.