Description

This project is a codebase for a backend API developed with Nest, designed to be compatible with any type of application (management, messaging, etc.).
It natively integrates a JWT authentication system, follows a clear MVC architecture, and adheres to Clean Code principles.
The project structure is optimized, extensible, and easily customizable to fit your specific needs.

Project setup

1. Clone dépôt git

   git clone <https://github.com/Jedidiaamy-2427/nest-api-backend.git>
   cd api-backend-server

2. Install basic dependencies

   npm install

3. Run the interactive setup script

   This script will prompt you for the necessary information (project name, database type, ports, etc.), generate the .env file, and install the dependencies.

   npx ts-node scripts/setup.ts

   Si ts-node n'est pas installé, lancez d'abord :

   npm install -D ts-node

4. Start the project

   npm run start:dev

Docker Setup

To make it easier to install and run your application with Docker, follow these steps:

1. Make sure you have Docker and Docker Compose installed on your machine.
2. Create an .env file at the root of the project with the necessary environment variables (the setup.ts script can help you).
3. Build and start the Docker containers:

# Build application 
$ docker-compose up --build

The application will be accessible on the port defined in your .env file (default 3000).

API Documentation

The API documentation is automatically generated and available via Swagger. To access it, start the application and open your browser to:

http://localhost:3001/api-docs

This documentation will allow you to visualize and test the different routes of the API.

More info

• LinkedIn - Jedidia Amy