95 lines
2.8 KiB
Markdown
95 lines
2.8 KiB
Markdown
# Sokko G
|
||
|
||
Webapp 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.
|
||
|
||
## Fonctionnalités
|
||
|
||
- Toolboxes locales stockées dans `localStorage`.
|
||
- Outils disponibles : bloc notes, checklist avec quantités, screenshots.
|
||
- Import/export d’une toolbox.
|
||
- Import/export global de toutes les toolboxes.
|
||
- Association locale entre une page jeu et une toolbox.
|
||
- Panneau latéral redimensionnable sur les pages jeux.
|
||
- Suivi et contrôle du quota localStorage.
|
||
- Pages de guides de jeu éditables via JSON.
|
||
|
||
## Démarrage
|
||
|
||
```bash
|
||
npm run dev
|
||
```
|
||
|
||
Par défaut, le site démarre sur `http://localhost:5173`.
|
||
|
||
## Configuration
|
||
|
||
Le serveur lit automatiquement un fichier `.env` à la racine du projet.
|
||
|
||
```bash
|
||
cp .env.example .env
|
||
```
|
||
|
||
Exemple :
|
||
|
||
```env
|
||
PORT=5173
|
||
```
|
||
|
||
Le fichier `.env` est ignoré par git. Pour changer le port localement, modifier `PORT`.
|
||
|
||
## Vérifications
|
||
|
||
Avant un push ou une mise en ligne :
|
||
|
||
```bash
|
||
npm run check
|
||
```
|
||
|
||
Cette commande vérifie la syntaxe de `website/src/app.js`, celle de `server.mjs`, puis lance les tests.
|
||
|
||
## Contenu éditable
|
||
|
||
Les contenus maintenus à la main sont regroupés dans `website/public/data`.
|
||
|
||
| Fichier | Rôle |
|
||
| --- | --- |
|
||
| `website/public/data/site.json` | Textes généraux du site : home, navigation, sidebar, page toolboxes. |
|
||
| `website/public/data/games.json` | Liste des jeux affichés sur `/games` et contenus des cards jeux. |
|
||
| `website/public/data/mhwilds/monsters.json` | Données des monstres Monster Hunter Wilds. |
|
||
| `website/public/data/mhwilds/endemic_life.json` | Données de la faune Monster Hunter Wilds. |
|
||
| `website/public/data/mhwilds/i18n/fr.json` | Traductions françaises des données MHWilds. |
|
||
| `website/public/data/mhwilds/i18n/en.json` | Traductions anglaises des données MHWilds. |
|
||
| `website/public/data/toolbox-icons.json` | Manifeste des icônes SVG réutilisables. |
|
||
|
||
Les images publiques sont dans `website/public/static`.
|
||
|
||
## Structure
|
||
|
||
```text
|
||
.
|
||
├── DESIGN_SYSTEM.md
|
||
├── package.json
|
||
├── server.mjs
|
||
├── tests/
|
||
└── website/
|
||
├── public/
|
||
│ ├── data/
|
||
│ ├── static/
|
||
│ └── index.html
|
||
└── src/
|
||
├── app.js
|
||
└── styles.css
|
||
```
|
||
|
||
## Stockage local
|
||
|
||
Clés principales :
|
||
|
||
- `sokkog:toolboxes` : registre local des toolboxes.
|
||
- `sokkog:game-toolbox-links` : associations locales jeu -> toolbox.
|
||
- `sokkog:toolbox:{toolboxId}:module:{moduleId}` : données de chaque outil.
|
||
- `sokkog:drawer-width` : largeur du panneau latéral.
|
||
|
||
Le quota applicatif est contrôlé côté navigateur avant écriture. Les imports globaux simulent l’espace nécessaire avant de modifier les données locales.
|