Aller au contenu

Boaz Housing - Documentation Technique

Bienvenue dans la documentation technique de Boaz Housing, l'application de gestion de logements et de souscriptions (recherche de logement, souscription, paiement, attestations).

Vue d'ensemble

Boaz Housing est une application fullstack :

  • Frontend : React (interface utilisateur, cartographie des logements, paiement).
  • Backend : FastAPI (API REST, gestion des logements/souscriptions, generation de documents, WebSocket temps reel).
  • Base de donnees : PostgreSQL.
  • Paiements : Stripe.
  • Administration BDD : pgAdmin.
flowchart LR
    U[Utilisateur] -->|HTTPS| P[Proxy nginx central]
    P -->|housing.boaz-study.tech| F[Frontend React]
    P -->|api-housing.boaz-study.tech| B[Backend FastAPI]
    F --> B
    B --> D[(PostgreSQL)]
    B -->|paiements| S[Stripe]
    B -.->|WebSocket temps reel| F

Les trois environnements

Environnement Branche Domaines Projet Docker
Local (PC) - localhost boaz_housing_local
Test dev test-housing / api-test-housing.boaz-study.tech boaz_housing_test
Production main housing / api-housing.boaz-study.tech boaz_housing

Chaque environnement est totalement isole (conteneurs, volumes, reseaux, base de donnees distincts).

Cycle de deploiement (CI/CD)

flowchart TD
    A[git push dev] --> B[GitHub Actions]
    B --> C[Runner self-hosted<br/>label housing-deploy-server]
    C --> D[Build images + docker compose up]
    D --> E[Health check backend]
    E -->|OK| F[Environnement TEST a jour]

    G[git push main] --> H[GitHub Actions]
    H --> I[Runner self-hosted]
    I --> J[Backup obligatoire local + S3]
    J --> K[Tag rollback + build + up]
    K --> L[Health check]
    L -->|OK| M[PROD a jour]
    L -->|Echec| N[Rollback automatique]

Par ou commencer

Compatibilite Backstage

Cette documentation est compatible Backstage TechDocs (plugin techdocs-core). Voir Integration Backstage.