chore: update README
- commit
- 1e860e4d44dfc26619b019500f4e4fb77a7cfbf1
- author
- Kit · · 2025-02-13 07:26 UTC
- parent
- 6251ded
- signature
- SSH Unverified
SHA256:H91DFuEG4jpk5edzLA4aUKkpv4zv9Q339ipRmkph6TkThe key is unknown
3 files · +57 -20
A .env example +2 -0
| @@ -0,0 +1,2 @@ | |||
| 1 | + | TURSO_DATABASE_URL= | |
| 2 | + | TURSO_AUTH_TOKEN=⏎̸ | |
| @@ -0,0 +1,2 @@ | |||||
| 1 | + | TURSO_DATABASE_URL= | |||
| 2 | + | TURSO_AUTH_TOKEN=⏎̸ | |||
M README.md +54 -19
| @@ -1,38 +1,73 @@ | |||
| 1 | - | # sv | |
| 1 | + | # Bienvenue | |
| 2 | 2 | ||
| 3 | - | Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). | |
| 3 | + | Ce 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 | 4 | ||
| 5 | - | ## Creating a project | |
| 5 | + | ## Technologies utilisées | |
| 6 | + | - SvelteKit (version 5) | |
| 7 | + | - Node.js | |
| 8 | + | - TypeScript | |
| 9 | + | - XP.css | |
| 10 | + | - Tailwind CSS | |
| 6 | 11 | ||
| 7 | - | If you're seeing this, you've probably already done this step. Congrats! | |
| 8 | 12 | ||
| 9 | - | ```bash | |
| 10 | - | # create a new project in the current directory | |
| 11 | - | npx sv create | |
| 13 | + | ## Prérequis | |
| 14 | + | - Node.js (>=22.13.0) | |
| 15 | + | - npm ou pnpm pour la gestion des packages | |
| 12 | 16 | ||
| 13 | - | # create a new project in my-app | |
| 14 | - | npx sv create my-app | |
| 15 | - | ``` | |
| 17 | + | ## Installation | |
| 18 | + | Clonez le dépôt et installez les dépendances : | |
| 16 | 19 | ||
| 17 | - | ## Developing | |
| 20 | + | ```bash | |
| 21 | + | npm install | |
| 22 | + | # ou | |
| 23 | + | pnpm install | |
| 24 | + | ``` | |
| 18 | 25 | ||
| 19 | - | Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: | |
| 26 | + | ## Lancement du projet | |
| 27 | + | Lancez le projet en mode développement : | |
| 20 | 28 | ||
| 21 | 29 | ```bash | |
| 22 | 30 | npm run dev | |
| 31 | + | # ou | |
| 32 | + | pnpm dev | |
| 33 | + | ``` | |
| 34 | + | ||
| 35 | + | Le site sera accessible via http://localhost:5173 par défaut. | |
| 36 | + | ||
| 37 | + | ## Contribution | |
| 38 | + | Toute contribution visant à améliorer le réalisme et la qualité du projet est la bienvenue ! | |
| 39 | + | Pour contribuer : | |
| 40 | + | - Forkez ce dépôt | |
| 41 | + | - Créez une branche pour vos modifications | |
| 42 | + | - Envoyez une pull request en décrivant clairement vos changements | |
| 23 | 43 | ||
| 24 | - | # or start the server and open the app in a new browser tab | |
| 25 | - | npm run dev -- --open | |
| 44 | + | ## Base de données | |
| 45 | + | ||
| 46 | + | Si vous souhaitez pouvoir tester le chat en local, vous devez configurer une base de données. Le projet utilise Drizzle ORM et Turso https://turso.tech/ comme base de données. Je vous invite à en créer une pour vos tests en local et à regarder le fichier `.env.example`. | |
| 47 | + | ||
| 48 | + | Pour générer les schémas de la base de données, exécutez la commande suivante : | |
| 49 | + | ||
| 50 | + | ```bash | |
| 51 | + | npm run db:generate | |
| 52 | + | # ou | |
| 53 | + | pnpm db:generate | |
| 26 | 54 | ``` | |
| 27 | 55 | ||
| 28 | - | ## Building | |
| 56 | + | Pour pousser les schémas à la base de données, exécutez la commande suivante : | |
| 29 | 57 | ||
| 30 | - | To create a production version of your app: | |
| 58 | + | ```bash | |
| 59 | + | npm run db:push | |
| 60 | + | # ou | |
| 61 | + | pnpm db:push | |
| 62 | + | ``` | |
| 63 | + | Vous pouvez avoir un aperçu du contenu de la base en utilisant : | |
| 31 | 64 | ||
| 32 | 65 | ```bash | |
| 33 | - | npm run build | |
| 66 | + | npx drizzle-kit studio | |
| 34 | 67 | ``` | |
| 35 | 68 | ||
| 36 | - | You can preview the production build with `npm run preview`. | |
| 69 | + | ## Documentation et Ressources | |
| 70 | + | Si vous n'avez jamais utilisé Svelte/Kit, référez-vous aux documentations officielles : | |
| 71 | + | - [Documentation de Svelte](https://svelte.dev/docs/) | |
| 72 | + | - [Documentation de SvelteKit](https://svelte.dev/docs/kit/@sveltejs-kit) | |
| 37 | 73 | ||
| 38 | - | > To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment. | |
| @@ -1,38 +1,73 @@ | |||||
| 1 | - | # sv | 1 | + | # Bienvenue |
| 2 | 2 | ||||
| 3 | - | Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). | 3 | + | Ce 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 | 4 | ||||
| 5 | - | ## Creating a project | 5 | + | ## Technologies utilisées |
| 6 | + | - SvelteKit (version 5) | |||
| 7 | + | - Node.js | |||
| 8 | + | - TypeScript | |||
| 9 | + | - XP.css | |||
| 10 | + | - Tailwind CSS | |||
| 6 | 11 | ||||
| 7 | - | If you're seeing this, you've probably already done this step. Congrats! | |||
| 8 | 12 | ||||
| 9 | - | ```bash | 13 | + | ## Prérequis |
| 10 | - | # create a new project in the current directory | 14 | + | - Node.js (>=22.13.0) |
| 11 | - | npx sv create | 15 | + | - npm ou pnpm pour la gestion des packages |
| 12 | 16 | ||||
| 13 | - | # create a new project in my-app | 17 | + | ## Installation |
| 14 | - | npx sv create my-app | 18 | + | Clonez le dépôt et installez les dépendances : |
| 15 | - | ``` | |||
| 16 | 19 | ||||
| 17 | - | ## Developing | 20 | + | ```bash |
| 21 | + | npm install | |||
| 22 | + | # ou | |||
| 23 | + | pnpm install | |||
| 24 | + | ``` | |||
| 18 | 25 | ||||
| 19 | - | Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: | 26 | + | ## Lancement du projet |
| 27 | + | Lancez le projet en mode développement : | |||
| 20 | 28 | ||||
| 21 | ```bash | 29 | ```bash | ||
| 22 | npm run dev | 30 | npm run dev | ||
| 31 | + | # ou | |||
| 32 | + | pnpm dev | |||
| 33 | + | ``` | |||
| 34 | + | ||||
| 35 | + | Le site sera accessible via http://localhost:5173 par défaut. | |||
| 36 | + | ||||
| 37 | + | ## Contribution | |||
| 38 | + | Toute contribution visant à améliorer le réalisme et la qualité du projet est la bienvenue ! | |||
| 39 | + | Pour contribuer : | |||
| 40 | + | - Forkez ce dépôt | |||
| 41 | + | - Créez une branche pour vos modifications | |||
| 42 | + | - Envoyez une pull request en décrivant clairement vos changements | |||
| 23 | 43 | ||||
| 24 | - | # or start the server and open the app in a new browser tab | 44 | + | ## Base de données |
| 25 | - | npm run dev -- --open | 45 | + | |
| 46 | + | Si vous souhaitez pouvoir tester le chat en local, vous devez configurer une base de données. Le projet utilise Drizzle ORM et Turso https://turso.tech/ comme base de données. Je vous invite à en créer une pour vos tests en local et à regarder le fichier `.env.example`. | |||
| 47 | + | ||||
| 48 | + | Pour générer les schémas de la base de données, exécutez la commande suivante : | |||
| 49 | + | ||||
| 50 | + | ```bash | |||
| 51 | + | npm run db:generate | |||
| 52 | + | # ou | |||
| 53 | + | pnpm db:generate | |||
| 26 | ``` | 54 | ``` | ||
| 27 | 55 | ||||
| 28 | - | ## Building | 56 | + | Pour pousser les schémas à la base de données, exécutez la commande suivante : |
| 29 | 57 | ||||
| 30 | - | To create a production version of your app: | 58 | + | ```bash |
| 59 | + | npm run db:push | |||
| 60 | + | # ou | |||
| 61 | + | pnpm db:push | |||
| 62 | + | ``` | |||
| 63 | + | Vous pouvez avoir un aperçu du contenu de la base en utilisant : | |||
| 31 | 64 | ||||
| 32 | ```bash | 65 | ```bash | ||
| 33 | - | npm run build | 66 | + | npx drizzle-kit studio |
| 34 | ``` | 67 | ``` | ||
| 35 | 68 | ||||
| 36 | - | You can preview the production build with `npm run preview`. | 69 | + | ## Documentation et Ressources |
| 70 | + | Si vous n'avez jamais utilisé Svelte/Kit, référez-vous aux documentations officielles : | |||
| 71 | + | - [Documentation de Svelte](https://svelte.dev/docs/) | |||
| 72 | + | - [Documentation de SvelteKit](https://svelte.dev/docs/kit/@sveltejs-kit) | |||
| 37 | 73 | ||||
| 38 | - | > To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment. | |||
M package.json +1 -1
| @@ -1,7 +1,7 @@ | |||
| 1 | 1 | { | |
| 2 | 2 | "name": "pdraim", | |
| 3 | 3 | "private": true, | |
| 4 | - | "version": "0.0.1", | |
| 4 | + | "version": "0.1.0", | |
| 5 | 5 | "type": "module", | |
| 6 | 6 | "engines": { | |
| 7 | 7 | "node": ">=22.13.0" | |
| @@ -1,7 +1,7 @@ | |||||
| 1 | { | 1 | { | ||
| 2 | "name": "pdraim", | 2 | "name": "pdraim", | ||
| 3 | "private": true, | 3 | "private": true, | ||
| 4 | - | "version": "0.0.1", | 4 | + | "version": "0.1.0", |
| 5 | "type": "module", | 5 | "type": "module", | ||
| 6 | "engines": { | 6 | "engines": { | ||
| 7 | "node": ">=22.13.0" | 7 | "node": ">=22.13.0" | ||