1# Bienvenue
2
3Ce projet _sandbox_, à but non lucratif, recrée l'ambiance des salons de discussion de l'époque AOL/AIM ; il est accessible à l'adresse : https://pdraim.org.
4
5## Technologies utilisées
6
7- SvelteKit (version 5)
8- Node.js
9- TypeScript
10- Convex (base de données temps réel)
11- XP.css
12- Tailwind CSS
13
14## Prérequis
15
16- Node.js (>=22.13.0)
17- npm ou pnpm pour la gestion des packages
18
19## Installation
20
21Clonez le dépôt et installez les dépendances :
22
23```bash
24npm install
25# ou
26pnpm install
27```
28
29## Lancement du projet
30
31Lancez le projet en mode développement :
32
33```bash
34npm run dev
35# ou
36pnpm dev
37```
38
39Le site sera accessible via http://localhost:5173 par défaut.
40
41## Contribution
42
43Toute contribution visant à améliorer le réalisme et la qualité du projet est la bienvenue !
44Pour contribuer :
45
46- Forkez ce dépôt
47- Créez une branche pour vos modifications
48- Envoyez une pull request en décrivant clairement vos changements
49
50## Base de données
51
52Le projet utilise [Convex](https://convex.dev/) comme base de données temps réel. Convex gère automatiquement les mises à jour en temps réel des messages et de la liste des utilisateurs.
53
54### Configuration locale
55
561. Créez un compte sur [Convex](https://convex.dev/) et un nouveau projet
572. Copiez `.env.example` vers `.env.local` et remplissez les variables :
58   - `PUBLIC_CONVEX_URL` : URL de votre déploiement Convex
59   - `CONVEX_API_SECRET` : Clé secrète pour les appels serveur
60
61### Lancer Convex en développement
62
63Dans un terminal séparé, lancez le serveur Convex :
64
65```bash
66npx convex dev
67```
68
69Cela synchronise automatiquement vos fonctions backend avec Convex et affiche les logs en temps réel.
70
71### Dashboard Convex
72
73Vous pouvez visualiser et gérer vos données via le dashboard Convex :
74
75```bash
76npx convex dashboard
77```
78
79## Déploiement
80
81Le site tourne dans une image conteneur Node ([`adapter-node`](https://svelte.dev/docs/kit/adapter-node)), écoutant sur le port `3000`.
82
83```bash
84docker build -t pdraim .
85docker run --rm -p 3000:3000 --env-file .env.local -e ORIGIN=http://localhost:3000 pdraim
86```
87
88Toutes les variables sont lues au runtime (`$env/dynamic/*`) : la même image sert en local et en production.
89
90| Variable                                            | Rôle                                    |
91| --------------------------------------------------- | --------------------------------------- |
92| `PUBLIC_CONVEX_URL`, `CONVEX_API_SECRET`            | Accès à Convex                          |
93| `PUBLIC_TURNSTILE_SITE_KEY`, `TURNSTILE_SECRET_KEY` | Cloudflare Turnstile                    |
94| `ORIGIN`                                            | URL publique (ex. `https://pdraim.org`) |
95| `ADDRESS_HEADER` (ex. `x-real-ip`)                  | IP client derrière les reverse proxies  |
96| `COOKIE_DOMAIN` (optionnel)                         | Cookie partagé entre sous-domaines      |
97
98## Documentation et Ressources
99
100Si vous n'avez jamais utilisé Svelte/Kit ou Convex, référez-vous aux documentations officielles :
101
102- [Documentation de Svelte](https://svelte.dev/docs/)
103- [Documentation de SvelteKit](https://svelte.dev/docs/kit/@sveltejs-kit)
104- [Documentation de Convex](https://docs.convex.dev/)
105- [Convex + Svelte](https://docs.convex.dev/client/svelte)