Add README and gitignore for local secrets
This commit is contained in:
110
README.md
Normal file
110
README.md
Normal file
@@ -0,0 +1,110 @@
|
||||
# Beuz Video Game Collection
|
||||
|
||||
Application web simple pour gerer une collection de jeux video par plateforme et console.
|
||||
|
||||
## Objectif
|
||||
|
||||
Centraliser ta collection dans une interface rapide a utiliser, evolutive, et facile a maintenir.
|
||||
|
||||
## Fonctionnalites actuelles
|
||||
|
||||
- Gestion des plateformes par marque (ex: SONY, MICROSOFT)
|
||||
- Gestion des consoles par marque (ajout libre)
|
||||
- Onglets dynamiques marque/console
|
||||
- Compteur visuel du nombre de jeux par console (bulle sur l'onglet)
|
||||
- Ajout de jeux avec champs:
|
||||
- titre
|
||||
- genre
|
||||
- editeur
|
||||
- annee
|
||||
- cote estimee
|
||||
- prete a
|
||||
- Edition d'une fiche existante
|
||||
- Suppression d'un jeu
|
||||
- Statut de pret (marquer prete/rendu)
|
||||
- Persistance locale via `localStorage`
|
||||
|
||||
## Stack technique
|
||||
|
||||
- Frontend: HTML, CSS, JavaScript vanilla
|
||||
- Serveur web local: Nginx (conteneur Docker)
|
||||
- Orchestration: Docker Compose
|
||||
|
||||
## Structure du projet
|
||||
|
||||
```text
|
||||
.
|
||||
|- index.html
|
||||
|- styles.css
|
||||
|- app.js
|
||||
|- Dockerfile
|
||||
|- docker-compose.yml
|
||||
|- .dockerignore
|
||||
|- .env.example
|
||||
```
|
||||
|
||||
## Lancer en Docker
|
||||
|
||||
### 1) Configuration du port
|
||||
|
||||
Copie le fichier d'environnement:
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
Par defaut:
|
||||
|
||||
```env
|
||||
APP_PORT=7001
|
||||
```
|
||||
|
||||
Tu peux mettre `7000` si ce port est libre sur ta machine.
|
||||
|
||||
### 2) Build et demarrage
|
||||
|
||||
```bash
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
### 3) Ouvrir l'application
|
||||
|
||||
- [http://localhost:7001](http://localhost:7001) (par defaut)
|
||||
- ou [http://localhost:7000](http://localhost:7000) si `APP_PORT=7000`
|
||||
|
||||
### 4) Arreter
|
||||
|
||||
```bash
|
||||
docker compose down
|
||||
```
|
||||
|
||||
## Utilisation rapide
|
||||
|
||||
1. Ajoute une marque + une console dans la section "Plateformes et consoles".
|
||||
2. Selectionne une console.
|
||||
3. Ajoute tes jeux via le formulaire.
|
||||
4. Utilise `Editer` pour completer/modifier une fiche (ex: ajouter l'editeur plus tard).
|
||||
5. Consulte la bulle sur chaque onglet console pour voir le volume de jeux.
|
||||
|
||||
## Git / Gitea
|
||||
|
||||
Le remote est configure en SSH via l'alias `gitea-local` (port `222`).
|
||||
|
||||
Exemples:
|
||||
|
||||
```bash
|
||||
git push
|
||||
git pull
|
||||
```
|
||||
|
||||
## Evolutions prevues
|
||||
|
||||
- Fiches de pret plus detaillees (date de sortie, date de retour)
|
||||
- Historique des prets
|
||||
- Statistiques de collection (total jeux, valeur totale, repartition par plateforme)
|
||||
- Export/import (CSV/JSON)
|
||||
- Sauvegarde distante (API/backend)
|
||||
|
||||
## Licence
|
||||
|
||||
Projet prive personnel.
|
||||
Reference in New Issue
Block a user