501f7fae931de5bb6104be02ea58f85b2a2230a1
Stripstream
Une application web moderne pour lire des bandes dessinées numériques, construite avec Next.js 14 et l'API Komga.
🚀 Technologies
🛠 Prérequis
- Node.js 20.x ou supérieur
- npm 10.x ou supérieur
- Docker et Docker Compose (optionnel)
📦 Installation
Méthode classique
- Cloner le repository
git clone [url-du-repo]
cd stripstream
- Installer les dépendances
npm install
-
Créer un fichier
.env.localà la racine du projet -
Lancer le serveur de développement
npm run dev
Avec Docker
- Cloner le repository et se placer dans le dossier
git clone [url-du-repo]
cd stripstream
- Lancer avec Docker Compose
docker-compose up --build
L'application sera accessible sur http://localhost:3000
🔧 Scripts disponibles
npm run dev- Lance le serveur de développementnpm run build- Crée une version de productionnpm start- Lance la version de productionnpm run lint- Vérifie le code avec ESLint
🌐 API Komga
L'application utilise l'API Komga pour la gestion des bandes dessinées. La documentation de l'API est disponible ici : Documentation Komga API
🏗 Structure du projet
src/
├── app/ # Pages et routes Next.js
├── components/ # Composants React réutilisables
│ ├── home/ # Composants spécifiques à la page d'accueil
│ ├── layout/ # Composants de mise en page
│ ├── reader/ # Composants du lecteur de BD
│ └── ui/ # Composants UI réutilisables
├── lib/ # Utilitaires et services
│ └── services/ # Services pour l'API et autres fonctionnalités
└── styles/ # Styles globaux
🤝 Contribution
- Créer une branche pour votre fonctionnalité
- Commiter vos changements
- Pousser vers la branche
- Ouvrir une Pull Request
📝 Guidelines de développement
- Suivre les principes DRY (Don't Repeat Yourself)
- Utiliser TypeScript pour tout nouveau code
- Utiliser les classes Tailwind pour le styling
- Implémenter les fonctionnalités d'accessibilité
- Mettre à jour le devbook.md pour toute modification significative
📄 Licence
Ce projet est sous licence [insérer type de licence]
Description
Languages
TypeScript
93.6%
JavaScript
5.1%
CSS
0.5%
Dockerfile
0.4%
HTML
0.3%