INSTALL.md

Back to README

Installation guide

Dependencies

You have to install these softwares before starting :

• Docker Engine
• Docker Compose
• NodeJS v.22.17.1

Table of contents

Choose your operating system :

• Windows
• MacOS
• Linux

Windows

We recommend using a WSL for this project. If so, please follow the Linux procedure.

A. Requirements

1. Create a .env file by copying the example file .env.example file. These values are only for the local environment, you can modify it if you want.

2. Start docker services with the following command

docker-compose up -d

3. You need to install NodeJS packages

npm install

4. Generate database schema

npm run prisma:push

5. Generate data with Prisma seed

npm run prisma:seed

B. Getting Started

1. Launch the application in development mode

npm run dev

2. Well done, the application is running!

• UI : http://localhost:3000/ui (homepage)
• API : http://localhost:3000/api/docs (Swagger documentation)

C. Quality Assurance

• Run unit tests

npm test

• Run unit tests with coverage

npm run test:cov

D. Database

• Reset Prisma database

npm run prisma:reset
npm run prisma:seed

MacOS

A. Requirements

1. Create a .env file by copying the example file .env.example file. You can modify it if you want.

2. Start docker services with the following command

docker-compose up -d

3. You need to install NodeJS packages

npm install

4. Generate database schema

npm run prisma:push

5. Generate data with Prisma seed

npm run prisma:seed

B. Getting Started

1. Launch the application in development mode

npm run dev

2. Well done, the application is running!

• UI : http://localhost:3000/ui (homepage)
• API : http://localhost:3000/api/docs (Swagger documentation)

C. Quality Assurance

• Run unit tests

npm test

• Run unit tests with coverage

npm run test:cov

D. Database

• Reset Prisma database

npm run prisma:reset
npm run prisma:seed

Linux

A. Requirements

1. Create a .env file by copying the example file .env.example file. You can modify it if you want.

2. Start docker services with the following command

docker-compose up -d

3. You need to install NodeJS packages

npm install

4. Generate database schema

npm run prisma:push

5. Generate data with Prisma seed

npm run prisma:seed

B. Getting Started

1. Launch the application in development mode

npm run dev

2. Well done, the application is running!

• UI : http://localhost:3000/ui (homepage)
• API : http://localhost:3000/api/docs (Swagger documentation)

C. Quality Assurance

• Run unit tests

npm test

• Run unit tests with coverage

npm run test:cov

D. Database

• Reset Prisma database

npm run prisma:reset
npm run prisma:seed