docs: update README and dependencies, add .gitignore entry

Reorganized README sections, adding project overview and implementation guides for better navigation. Added `.gitignore` entry to exclude `node_modules`. Updated `pnpm-lock.yaml` with new dependencies for authentication, database, and real-time communication modules.
This commit is contained in:
Mathis H (Avnyr) 2025-05-15 17:13:05 +02:00
parent b8fc2219b9
commit 2035821e89
4 changed files with 1677 additions and 110 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
node_modules

View File

@ -229,13 +229,16 @@ pnpm --filter <package-name> add -D <dependency>
Pour plus de détails sur l'implémentation et l'architecture de l'application, consultez les documents suivants :
- [Diagrammes de Flux Métier](BUSINESS_FLOW_DIAGRAMS.md) - Diagrammes de séquence pour les principaux flux métier de l'application
- [Plan d'Implémentation du Backend](BACKEND_IMPLEMENTATION_PLAN.md) - Plan détaillé pour l'implémentation du backend
- [Plan du Schéma de Base de Données](DATABASE_SCHEMA_PLAN.md) - Définition du schéma de base de données avec DrizzleORM
- [Plan d'Implémentation de l'Authentification](AUTH_IMPLEMENTATION_PLAN.md) - Détails sur l'implémentation de l'authentification OAuth avec GitHub
- [Plan d'Implémentation des WebSockets](WEBSOCKET_IMPLEMENTATION_PLAN.md) - Plan pour la communication en temps réel
- [Guide d'Implémentation](IMPLEMENTATION_GUIDE.md) - Guide complet pour l'implémentation du backend
- [Résumé et Prochaines Étapes](SUMMARY.md) - Résumé du travail effectué et prochaines étapes
### Vue d'Ensemble
- [Vue d'Ensemble du Projet](docs/PROJECT_OVERVIEW.md) - Analyse complète de l'architecture, des technologies et des fonctionnalités
- [État d'Avancement du Projet](docs/PROJECT_STATUS.md) - État actuel, tâches restantes et prochaines étapes
- [Diagrammes de Flux Métier](docs/BUSINESS_FLOW_DIAGRAMS.md) - Diagrammes de séquence pour les principaux flux métier
- [Cahier des Charges](docs/SPECIFICATIONS.md) - Spécifications initiales du projet
### Guides d'Implémentation
- [Guides d'Implémentation](docs/implementation/README.md) - Index des guides d'implémentation détaillés
Les plans d'implémentation détaillés pour chaque composant du système sont disponibles dans le répertoire `docs/implementation`.
## 👥 Contribution

45
docker-compose.yml Normal file
View File

@ -0,0 +1,45 @@
version: '3.8'
services:
backend:
build:
context: ./backend
dockerfile: Dockerfile
ports:
- "3000:3000"
environment:
- NODE_ENV=production
- POSTGRES_HOST=postgres
- POSTGRES_PORT=5432
- POSTGRES_DB=groupmaker
- POSTGRES_USER=postgres
- POSTGRES_PASSWORD=postgres
depends_on:
- postgres
restart: unless-stopped
frontend:
build:
context: ./frontend
dockerfile: Dockerfile
ports:
- "3001:3000"
environment:
- NODE_ENV=production
- NEXT_PUBLIC_API_URL=http://localhost:3000
restart: unless-stopped
postgres:
image: postgres:16-alpine
ports:
- "5432:5432"
environment:
- POSTGRES_DB=groupmaker
- POSTGRES_USER=postgres
- POSTGRES_PASSWORD=postgres
volumes:
- postgres_data:/var/lib/postgresql/data
restart: unless-stopped
volumes:
postgres_data:

1724
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff