Sloth Board

Documentation

Guide d'installation, stack technique et limites connues de Sloth Board.

Comment installer

Une fois l'application démarrée, la documentation Swagger de l'API est accessible localement à l'adresse suivante : Documentation Swagger.

[ 01 ]

Prérequis

Avant de commencer, installez les outils suivants sur votre machine.

Git : Installer Git
Docker Desktop : Installer Docker Desktop (Windows)

[ 02 ]

Démarrer Docker

Une fois les prérequis installés, lancez Docker Desktop et attendez que le moteur soit prêt.

[ 03 ]

Créer un répertoire de travail

Créez un dossier dédié au projet, puis placez-vous dedans.

Terminal

mkdir sloth-boardcd sloth-board

[ 04 ]

Cloner les dépôts

Dans ce répertoire, clonez les dépôts frontend et backend.

Terminal

git clone https://github.com/trainer-activity-team/frontend-sloth-boardgit clone https://github.com/trainer-activity-team/backend-sloth-board

[ 05 ]

Récupérer docker-compose.yml

Téléchargez le fichier suivant, puis placez-le à la racine du répertoire de travail.

Télécharger docker-compose.yml

Arborescence attendue

Après le clonage des dépôts et le placement de docker-compose.yml à la racine, votre répertoire de travail doit ressembler à ceci. Seuls les dossiers principaux et les fichiers clés sont affichés.

Structure du projet

sloth-board/
├── .env
├── docker-compose.yml
├── backend-sloth-board/
│   ├── prisma/
│   ├── src/
│   ├── test/
│   ├── Dockerfile
│   ├── package.json
│   └── .env
└── frontend-sloth-board/
    ├── public/
    ├── src/
    ├── Dockerfile
    ├── nginx.conf
    └── package.json

[ 06 ]

Fichier .env à la racine

À la racine du répertoire (à côté de docker-compose.yml), créez un fichier .env avec le contenu suivant.

.env

# PostgreSQLPOSTGRES_USER=CHANGE_MEPOSTGRES_PASSWORD=CHANGE_MEPOSTGRES_DB=CHANGE_MEPOSTGRES_PORT=CHANGE_ME# pgAdminPGADMIN_DEFAULT_EMAIL=CHANGE_MEPGADMIN_DEFAULT_PASSWORD=CHANGE_MEPGADMIN_PORT=CHANGE_ME# BackendJWT_SECRET=CHANGE_MEJWT_EXPIRES_IN=CHANGE_MESWAGGER_ENABLED=CHANGE_ME# FrontendFRONTEND_PORT=CHANGE_ME

[ 07 ]

Fichier .env dans backend-sloth-board/

Dans le dossier backend-sloth-board, créez un second fichier .env avec le contenu suivant.

backend-sloth-board/.env

DATABASE_URL="CHANGE_ME"JWT_SECRET="CHANGE_ME"JWT_EXPIRES_IN=CHANGE_MESWAGGER_ENABLED=CHANGE_ME

[ 08 ]

Lancer l'application

Depuis la racine du répertoire, démarrez tous les services en arrière-plan. L'application est accessible sur http://localhost (ou http://localhost:VOTRE_PORT si FRONTEND_PORT diffère de 80). La documentation Swagger est disponible sur http://localhost/docs/.

Terminal

docker compose up -d

Stack technique

Une application full stack auto-hébergeable : frontend React, backend NestJS avec Prisma, et base de données PostgreSQL.

Frontend

React
Tailwind CSS

Backend

NestJS
Prisma

Base de données

PostgreSQL

Limites connues

Contenu à venir.