Skip to content
BranchesTags

Repository files navigation

Flash

Plateforme de monnaie électronique (mobile money). Transferts entre particuliers, paiements marchands par QR, dépôts / retraits cash en agence, comptes opérateurs, coffre, épargne, carte virtuelle. Multi-pays (zone UEMOA / XOF au lancement). Frais de transfert : 0,8 %. Ledger en partie double.

Statut : toutes les phases livrées. Backend 84/84, Web 49/49, Mobile 47/47, Infra & CI/CD 24/24, Design 10/10, Fondations 6/6 (+ transverses BE-T1..T6, WEB-T1..T3, MOB-T1..T3). Détail : ROADMAP.md.

Démarrer

Option 1 : tout (backend + web + mobile) en une commande

./scripts/dev.sh

Ce script : copie .env.example -> .env si besoin, lève la pile Docker (PostgreSQL, Redis, Mailhog, API + seed complet, web), attend que l'API réponde, détecte l'IP LAN de la machine, puis lance flutter run de l'app mobile avec --dart-define=API_BASE_URL=http://<IP_LAN>:8000 — pour qu'un téléphone ou un émulateur du même réseau atteigne le backend.

  • SKIP_MOBILE=1 ./scripts/dev.sh : la pile seule (pas de mobile).
  • FLASH_LAN_IP=192.168.1.42 ./scripts/dev.sh : forcer l'IP.
  • ./scripts/dev.sh -d chrome : passer des options à flutter run.

Option 2 : la pile Docker seule

cp .env.example .env
docker compose -f infra/docker-compose.yml up --build     # ou : make up
Service URL
Application web http://localhost:5173 (et http://<IP_LAN>:5173)
Back-office http://localhost:5173/admin
API + doc interactive http://localhost:8000 et http://localhost:8000/docs
Boîte mail (Mailhog) http://localhost:8025

L'API applique les migrations, charge le référentiel puis joue flash seed (jeu de démo de tous les profils, idempotent).

Comptes de démonstration

Code secret commun : 1397. Détail et scénario pas à pas dans docs/GUIDE.md.

Numéro Profil
+2250700000101 / 102 clients, KYC palier 0
+2250700000103 cliente, KYC palier 1 (approuvé)
+2250700000104 client, dossier KYC en attente
+2250700000199 agent (float, commission)
+2250700000188 marchand (KYB approuvé, clé d'API, caisse)

Back-office, en-tête X-Admin-Key : dev-admin-key (admin/support), dev-compliance-key (conformité), dev-finance-key (finance).

Les codes OTP partent dans les logs de l'API : docker compose -f infra/docker-compose.yml logs -f api | grep -i otp.

Ce que fait Flash

Domaine Fonctionnalités
Client inscription + OTP, connexion (biométrie mobile), code secret oublié, solde masquable, envoyer (aperçu frais 0,8 %) + annuler, demander de l'argent, payer un marchand (scan QR), recevoir, retrait / dépôt cash, compte opérateur, historique + reçu partageable, coffre, épargne (intérêts), carte virtuelle (révéler PAN/CVV 30 s), 5 numéros, KYC par paliers, notifications (SSE + push FCM), appareils connectés, changer le code secret
Agent float plafonné, dépôt client, confirmation de retrait, top-up / withdraw float, commissions, hiérarchie (agent parent / sous-agents), journal + export CSV
Marchand enrôlement, KYB, clés d'API /merchant/v1, QR statique / dynamique, sous-comptes (caisses / employés), frais négociés par canal, webhooks signés (HMAC), remboursement, relevés & règlements bancaires, affiche imprimable
Back-office 4 rôles par clé X-Admin-Key : Support (recherche, gel, contre-passation forcée, notes, tickets, file KYC + aperçu des pièces), Conformité (alertes AML, scan par seuils, blocage préventif, export STR, audit + contrôle d'intégrité de la chaîne), Finance (balance générale, journal, exports mensuels, règlements, grille tarifaire & plafonds éditables), Admin
Jobs expiration d'opérations, réconciliation des soldes, épargne programmée + intérêts, règlements marchands, dispatch des webhooks, commissions agent

Architecture

Monorepo, architecture hexagonale (le domaine ne dépend d'aucune techno).

Dossier Contenu Stack
backend/ API + cœur métier + jobs + CLI Python 3.12, Flask, SQLAlchemy 2, Alembic, PostgreSQL, Redis, Pydantic v2
web/ App web (client + espace agent + back-office) React 18, Vite, TypeScript strict, TanStack Query, React Router, Zustand
mobile/ App mobile client Flutter 3, Dart, Riverpod, go_router, dio
infra/ Docker Compose dev, CI/CD, déploiement VPS, observabilité Docker, GitHub Actions, Caddy, Prometheus / Loki / Grafana
design/ Charte, logo, tokens, iconographie, modèle de reçu SVG, JSON tokens
docs/ Architecture, modèle métier, spec API, guides Markdown, OpenAPI 3.1

Principes non négociables : aucun TODO/FIXME de complaisance dans le code livré ; toute écriture d'argent produit des postings équilibrés (jamais de mutation de solde hors ledger) ; toute opération monétaire accepte une clé d'idempotence ; frais / limites / paliers KYC / devise / opérateurs pilotés par configuration, jamais en dur dans le métier.

Tous les documents

Suivi & décisions

Utilisation & conception

API

Exploitation

Développement

make help            # tous les raccourcis
make dev             # pile Docker + flutter run (IP LAN)  ->  scripts/dev.sh
make up              # pile Docker seule
make migrate seed    # migrations + jeu de démo dans le conteneur
make lint fmt test   # backend (ruff/mypy/pytest) + web (eslint/prettier/vitest)
make openapi         # régénère docs/api/openapi.json + le client TS du web

pre-commit : pipx install pre-commit && pre-commit install (voir .pre-commit-config.yaml).

Tests & CI

Lot Local CI (GitHub Actions)
Backend cd backend && pytest (couverture >= 90 %, 100 % domaine + application) backend-ci.yml (ruff, mypy, pytest + Postgres/Redis), openapi-check.yml
Web cd web && npm test && npm run e2e web-ci.yml (lint, typecheck, test:cov seuil 80 %, build, Playwright, Lighthouse >= 90)
Mobile cd mobile && flutter test (widget + provider + golden) mobile-ci.yml (dart format, flutter analyze, tests + coverage, build APK)
Images images.yml (GHCR flash-api / flash-web, SBOM + provenance, scan Trivy bloquant)
Déploiement deploy.yml (tag v* -> prod, main -> staging, migration avant bascule, health-check, rollback)

Sécurité & conformité

Le produit est complet côté fonctionnel, mais opérer une monnaie électronique exige : agrément BCEAO, intégrations bancaires / opérateurs / réseau carte de production (aujourd'hui des adaptateurs sandbox), audits PCI-DSS et sécurité, campagne de tests de charge sur l'infrastructure cible. Les connecteurs externes sont des ports isolés (OperatorGateway, CardIssuer, BankGateway) à remplacer par des implémentations agréées.

About

Plateforme de monnaie électronique (mobile money) transferts, paiements marchands, dépôts / retraits cash en agence, coffre, épargne, carte. Multi‑pays (zone UEMOA / XOF au lancement). Frais de transfert : 0,8 %.

Resources

Readme
Activity

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages