Une API robuste et scalable avec authentification, GraphQL et architecture containerisée
- 🐳 Docker & Docker Compose
- 🛠 GNU
make - 📦 Node.js (pour Lefthook)
-
Récupération du code source
git clone https://github.com/votre-utilisateur/khp-backend.git cd khp-backend -
Démarrage des services Docker
make up # Équivalent à: docker-compose up -d -
Installation des dépendances
make install # Installe les packages PHP et JavaScript -
Configuration de la base de données
make migrate # Exécute les migrations Laravel -
Configuration des hooks Git
⚠️ Importantnpm install # Installe Lefthook pour les hooks pre-commit
| Commande | Description |
|---|---|
make up |
Démarrer tous les conteneurs |
make down |
Arrêter tous les conteneurs |
make restart |
Redémarrer les conteneurs |
make build |
Reconstruire les images |
make exec |
Ouvrir un shell dans le conteneur |
make up-prod |
Démarrer en mode production |
| Commande | Description |
|---|---|
make install |
Installer les dépendances PHP/JS |
make migrate |
Exécuter les migrations |
make fresh |
Reset complet de la DB |
make tests |
Lancer tous les tests |
make cs / make pint |
Formater le code |
make larastan |
Analyse statique du code |
make erd |
Générer le diagramme ERD |
📚 Documentation complète : KHP-API-DOCS
Pour utiliser l'API REST :
-
Clonez le repository de documentation :
git clone https://github.com/GoofyTeam/KHP-API-DOCS.git
-
Suivez les instructions du repository pour configurer et tester l'API
| Endpoint | Description | Authentification |
|---|---|---|
/graphql |
API GraphQL | ✅ |
/graphiql |
Interface GraphiQL | ❌ (dev uniquement) |
Le projet utilise plusieurs outils pour maintenir la qualité :
- Laravel Pint : Formatage automatique du code PHP
- Laravel Erd : Génération de diagrammes ERD
- PHPStan + Larastan : Analyse statique
- Lefthook : Hooks Git pre-commit
- PHPUnit : Tests automatisés
Fait avec ❤️ par l'équipe GoofyTeam