Documentation Feelbat

Bienvenue dans la documentation technique de la plateforme Feelbat.

Cette documentation centralise les informations nécessaires pour comprendre, développer, déployer et maintenir le monorepo Feelbat.

À propos

Cette documentation est destinée aux développeurs travaillant sur la plateforme Feelbat. Elle couvre aussi bien l'architecture que les bonnes pratiques de développement et les procédures d'exploitation.

🚀 Bien démarrer

Vous découvrez le projet ? Commencez par ces guides :

🏛️ Architecture

Cette section explique les principaux choix techniques de la plateforme.

Prochainement :

Architecture hexagonale
Domain-Driven Design (DDD)
Kafka & Event Driven
Outbox Pattern
Système de permissions (ABAC)

💻 Développement

Vous y trouverez des guides pratiques pour développer sur la plateforme :

Créer un nouveau service
Ajouter un module GraphQL
Utiliser Kafka
Créer une migration
Écrire des tests

🚢 Opérations

Documentation liée à l'exploitation de la plateforme :

Déploiement
Processus de release
Sauvegarde et restauration
GitHub Actions

📚 Philosophie

L'objectif de cette documentation est de répondre à une question simple :

Comment faire ?

Chaque page doit répondre à une problématique précise afin de permettre à un développeur de trouver rapidement l'information recherchée.

🤝 Contribution

La documentation fait partie intégrante du projet.

Lorsque vous ajoutez une fonctionnalité, modifiez une architecture ou introduisez un nouveau processus, pensez à mettre à jour la documentation associée.