Aller au contenu

Vue d’ensemble des dépôts

Traduction

Cette page est une traduction de la version anglaise, qui fait foi.

Cette page décrit les dépôts GitHub constituant l’écosystème Balyze.

L’ensemble des dépôts est hébergé au sein de l’organisation GitHub Balyze. Chaque dépôt possède une responsabilité claire afin de garantir la lisibilité, l’évolutivité et la maintenabilité à long terme.

Tableau récapitulatif

Dépôt Rôle Public cible Visibilité Statut
balyze Backend central & logique métier Équipe de développement Privé Actif
balyze-website Site public du produit Public Public Actif
balyze-docs-tech Documentation technique Équipe de développement Privé Actif
balyze-docs-user Documentation utilisateur Utilisateurs finaux Public Prévu
balyze-docs-api Documentation API Intégrateurs Public Prévu
balyze-infra Infrastructure & déploiement Équipe ops Privé Optionnel
balyze-web-front Frontend web dédié Équipe de développement Privé Prévu
balyze-mobile-android Application mobile Android Équipe de développement Privé Prévu
balyze-mobile-apple Application mobile iOS Équipe de développement Privé Prévu

Dépôts cœur du produit

balyze

Dépôt GitHub : Balyze/balyze

Le backend central du produit Balyze.

Ce dépôt contient :

  • les modèles métier et règles de domaine
  • l’authentification et l’autorisation
  • les workflows applicatifs
  • les APIs consommées par le web et le mobile
  • éventuellement des vues serveur

Le dépôt balyze constitue la source de vérité du produit. Sa suppression équivaut à la suppression du produit lui-même.

balyze-website

Dépôt GitHub : Balyze/balyze-website

Le site public de présentation de Balyze.

Responsabilités :

  • présentation du produit
  • contenu marketing et SEO
  • informations publiques sur le projet et l’organisation
  • point d’entrée vers l’application et la documentation

Aucune logique métier n’est présente dans ce dépôt.

Dépôts de documentation

balyze-docs-tech

Dépôt GitHub : Balyze/balyze-docs-tech

Documentation technique destinée aux contributeurs et mainteneurs.

Contenu :

  • architecture
  • règles et concepts métier
  • principes de sécurité
  • décisions d’architecture (ADR)
  • références opérationnelles

Ce dépôt est privé et versionné indépendamment du produit.

balyze-docs-user (prévu)

Dépôt GitHub : Balyze/balyze-docs-user

Documentation à destination des utilisateurs finaux.

Contenu prévu :

  • guides d’utilisation
  • explication des fonctionnalités
  • documentation d’onboarding
  • FAQ utilisateur

balyze-docs-api (prévu)

Dépôt GitHub : Balyze/balyze-docs-api

Documentation publique de l’API.

Contenu prévu :

  • endpoints API
  • mécanismes d’authentification
  • formats de requêtes et réponses
  • exemples d’intégration

Interfaces prévues

Les dépôts suivants représentent des interfaces futures construites au-dessus du backend central de Balyze.

Ils ne sont pas nécessaires pour la version ALPHA mais font partie de la vision long terme du produit.

balyze-web-front (prévu)

Dépôt GitHub : Balyze/balyze-web-front

Frontend web dédié consommant l’API Balyze.

Ce dépôt hébergera une application frontend découplée lorsque l’API backend sera stabilisée.

balyze-mobile-android (prévu)

Dépôt GitHub : Balyze/balyze-mobile-android

Application mobile Android native.

balyze-mobile-apple (prévu)

Dépôt GitHub : Balyze/balyze-mobile-apple

Application mobile iOS native.

Infrastructure et opérations

balyze-infra (optionnel, futur)

Dépôt GitHub : Balyze/balyze-infra

Dépôt dédié à l’infrastructure et au déploiement.

Il pourra contenir :

  • de l’infrastructure-as-code
  • des pipelines de déploiement
  • des définitions d’environnements

Les secrets opérationnels ne sont jamais stockés dans les dépôts de documentation.

Principes directeurs

  • un dépôt = une responsabilité claire
  • les dépôts sont nommés selon leur rôle, pas leur technologie
  • le code produit, la documentation et l’infrastructure évoluent indépendamment
  • les nouveaux dépôts ne sont créés qu’en réponse à un besoin réel

Cette organisation privilégie la clarté et la stabilité à long terme.

Public visé

Ce document s’adresse :

  • aux mainteneurs
  • aux développeurs rejoignant le projet
  • aux contributeurs ayant besoin d’une vision système

Il ne s’agit pas d’une documentation utilisateur.