diff --git a/README.md b/README.md index d9cbd65..39d2097 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,64 @@ # ProjetBut3 +Portail SaaS B2B modulaire (projet tutoré BUT3). +Équipe : Mathis, Cleo, Ugo + +> Brouillon, à compléter au fil du projet. + +## Stack + +- Front : Vue 3 + TypeScript +- Back : NestJS +- Base : PostgreSQL (dans Docker) + +## Ce qu'il faut installer + +- **Git** +- **Node 26** (tous la même version) : `winget install Schniz.fnm`, puis `fnm install 26` et `fnm default 26`. Si `node -v` ne marche pas dans VS Code, fermer et rouvrir VS Code. +- **Docker Desktop** (à lancer avant de commencer) +- **VS Code** avec : Vue - Official, REST Client, ESLint, Prettier, Docker, PostgreSQL, GitLens + +## Lancer le projet + +```powershell +git clone https://grond.iut-fbleau.fr/camille/ProjetBut3.git +cd ProjetBut3 +Copy-Item .env.example .env +``` + +Ouvrir le `.env` et changer le mot de passe (ne jamais commiter ce fichier). + +Base de données : + +```powershell +docker compose up -d +``` + +Back (http://localhost:3000) : + +```powershell +cd backend +npm install +npm run start:dev +``` + +Front (http://localhost:5173), dans un autre terminal : + +```powershell +cd frontend +npm install +npm run dev +``` + +Adminer pour voir la base : http://localhost:8080 (système PostgreSQL, serveur `db`, identifiants du `.env`). + +## En cas de souci + +- Erreur Docker : Docker Desktop n'est pas lancé. +- Port 5432 déjà pris : mettre `POSTGRES_PORT=5433` dans le `.env`. +- PowerShell bloque les scripts : `Set-ExecutionPolicy -Scope CurrentUser RemoteSigned`. + +## Git + +- Une branche par fonctionnalité, pas de commit direct sur `main`. +- `git pull` avant de commencer. \ No newline at end of file