This commit is contained in:
parent
db4b99aee3
commit
1dee8b528f
30 changed files with 3491 additions and 2444 deletions
59
README.md
59
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# Sokko G
|
||||
|
||||
Webapp locale pour préparer et accompagner des sessions gaming sur second écran.
|
||||
Webapp React locale pour préparer et accompagner des sessions gaming sur second écran.
|
||||
|
||||
Sokko G propose des toolboxes modulaires stockées dans le navigateur, ainsi que des pages de guides de jeu maintenues dans le dépôt. Aucune donnée utilisateur n’est envoyée côté serveur.
|
||||
|
||||
|
|
@ -23,6 +23,15 @@ npm run dev
|
|||
|
||||
Par défaut, le site démarre sur `http://localhost:5173`.
|
||||
|
||||
Pour générer la version statique de production :
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
Le build est généré dans `website/dist`.
|
||||
`npm start` sert cette version statique avec `server.mjs`.
|
||||
|
||||
## Configuration
|
||||
|
||||
Le serveur lit automatiquement un fichier `.env` à la racine du projet.
|
||||
|
|
@ -47,7 +56,7 @@ Avant un push ou une mise en ligne :
|
|||
npm run check
|
||||
```
|
||||
|
||||
Cette commande vérifie la syntaxe de `website/src/app.js`, celle de `server.mjs`, puis lance les tests.
|
||||
Cette commande vérifie la configuration Node/Vite, lance les tests, puis exécute le build React.
|
||||
|
||||
## Contenu éditable
|
||||
|
||||
|
|
@ -65,6 +74,35 @@ Les contenus maintenus à la main sont regroupés dans `website/public/data`.
|
|||
|
||||
Les images publiques sont dans `website/public/static`.
|
||||
|
||||
## Pages jeux
|
||||
|
||||
Les pages jeux sont dans `website/src/features/games`.
|
||||
|
||||
- `website/src/features/games/GamesPage.jsx` : liste des jeux disponibles.
|
||||
- `website/src/features/games/GameRoute.jsx` : route vers la page du jeu demandé.
|
||||
- `website/src/features/games/mhwilds/` : vues et composants propres à Monster Hunter Wilds.
|
||||
|
||||
Pour ajouter un jeu :
|
||||
|
||||
- ajouter son entrée dans `website/public/data/games.json` ;
|
||||
- créer son dossier dans `website/src/features/games/` si la page nécessite un rendu spécifique ;
|
||||
- brancher sa route dans `website/src/features/games/GameRoute.jsx`.
|
||||
|
||||
## Outils de toolbox
|
||||
|
||||
Les outils de toolbox sont déclarés dans `website/src/features/toolboxes/modules/index.jsx`.
|
||||
Chaque outil possède son propre fichier de composant :
|
||||
|
||||
- `website/src/features/toolboxes/modules/NotepadModule.jsx`
|
||||
- `website/src/features/toolboxes/modules/ChecklistModule.jsx`
|
||||
- `website/src/features/toolboxes/modules/ScreenshotsModule.jsx`
|
||||
|
||||
Pour ajouter ou maintenir un outil :
|
||||
|
||||
- créer son fichier dans `website/src/features/toolboxes/modules/` ;
|
||||
- l’ajouter au registre `MODULE_COMPONENTS` dans `website/src/features/toolboxes/modules/index.jsx` ;
|
||||
- garder les données persistées via les helpers de `website/src/main.jsx` tant que le stockage reste en localStorage.
|
||||
|
||||
## Structure
|
||||
|
||||
```text
|
||||
|
|
@ -72,15 +110,24 @@ Les images publiques sont dans `website/public/static`.
|
|||
├── DESIGN_SYSTEM.md
|
||||
├── package.json
|
||||
├── server.mjs
|
||||
├── vite.config.js
|
||||
├── tests/
|
||||
└── website/
|
||||
├── index.html
|
||||
├── public/
|
||||
│ ├── data/
|
||||
│ ├── static/
|
||||
│ └── index.html
|
||||
│ └── static/
|
||||
└── src/
|
||||
├── app.js
|
||||
└── styles.css
|
||||
├── main.jsx
|
||||
├── components/
|
||||
├── features/
|
||||
│ ├── games/
|
||||
│ │ └── mhwilds/
|
||||
│ └── toolboxes/
|
||||
│ └── modules/
|
||||
└── styles/
|
||||
├── _tokens.scss
|
||||
└── main.scss
|
||||
```
|
||||
|
||||
## Stockage local
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue