Documentation — Bank Transaction¶
Bienvenue. Cette documentation explique, pas à pas et en langage simple, comment installer, faire fonctionner et exploiter l'application Bank Transaction.
Quel guide pour quoi ?¶
| Je veux… | Va dans… |
|---|---|
| Comprendre le projet et ses 3 environnements | Comprendre le projet |
| Coder sur mon PC (Windows) | Déploiement Local |
| Comprendre / utiliser l'environnement de TEST | Déploiement Dev / Test |
| Comprendre / déployer en PRODUCTION | Déploiement Production |
| Sauvegarder / restaurer, voir la base (pgAdmin), déplacer les configs | Exploitation |
| Ajouter une nouvelle banque | Guides métier |
Les 3 environnements en une phrase¶
- Local = sur ton PC, pour développer. Données jetables, services de test.
- Test (dev) = sur le serveur, adresse
test-transaction.boaz-study.tech. Pour essayer avant la prod. - Production = sur le serveur, adresse
transaction.boaz-study.tech. Les vrais clients.
Comment on met à jour l'application (le principe)¶
flowchart TD
PC["Tu codes sur ton PC"] -->|git push / merge| GH["GitHub<br/>(le code)"]
GH -->|branche dev| TEST["Déploie tout seul<br/>le TEST"]
GH -->|branche main| PROD["Déploie tout seul<br/>la PRODUCTION"]
Tu ne te connectes jamais au serveur pour déployer : tu pousses ton code sur GitHub, et le déploiement se fait automatiquement. (Détails dans les sections Dev et Prod.)
Accéder à cette documentation¶
Cette documentation tourne comme un service de l'application (elle est reconstruite à chaque déploiement). Elle est accessible dans chaque environnement :
| Environnement | Adresse de la documentation |
|---|---|
| Local (ton PC) | http://localhost:8090 |
| Test | http://151.80.144.98:8090 |
| Production | https://docs-transaction.boaz-study.tech |
La version « officielle » à partager est celle de production : docs-transaction.boaz-study.tech. Elle est aussi consultable depuis le portail Backstage (voir Intégration Backstage).
Petit glossaire (sans jargon)¶
| Mot | Ce que ça veut dire |
|---|---|
| Docker | Un moteur qui fait tourner l'app dans des « boîtes » isolées (conteneurs). |
| Conteneur | Une « boîte » qui contient un morceau de l'app (la base, l'API, le site…). |
| Image | Le « moule » figé à partir duquel on crée un conteneur. |
| Volume | L'endroit où Docker garde les données (elles survivent aux redémarrages). |
| CI/CD | Le robot qui déploie automatiquement quand tu pousses ton code. |
Branche dev / main |
dev = version de test ; main = version en production. |
.env |
Un fichier qui contient les réglages et mots de passe (jamais mis sur GitHub). |