81 lines
3.2 KiB
Markdown
81 lines
3.2 KiB
Markdown
# Finances du foyer
|
|
|
|
Suivi des entrées, dépenses et charges partagées d'un foyer de deux personnes :
|
|
répartition en %, « qui doit combien à qui », récurrents, dépenses prévues, budgets,
|
|
remboursements employeur affectés à une charge (IK, part de loyer…) et crédits.
|
|
|
|
Stack : Next.js 15 (TypeScript) + MariaDB, le tout sous Docker Compose. Accès réseau local uniquement (HTTP).
|
|
|
|
## Installation sur la VM
|
|
|
|
Prérequis : Docker et le plugin `docker compose`, git, et un accès Internet pendant le build (paquets npm, police Inter).
|
|
|
|
```bash
|
|
git clone git@git.fabout.it:hcloez/hcl-finances-manager.git
|
|
cd hcl-finances-manager
|
|
cp .env.example .env
|
|
# Renseigner les 3 secrets dans .env (un par ligne) :
|
|
openssl rand -hex 32 # → MARIADB_ROOT_PASSWORD
|
|
openssl rand -hex 32 # → MARIADB_PASSWORD
|
|
openssl rand -hex 32 # → SESSION_SECRET
|
|
docker compose up -d --build
|
|
```
|
|
|
|
Ouvrir ensuite **http://192.168.1.211:3000**. Au premier accès, un écran d'installation crée les deux comptes
|
|
(prénom, identifiant, mot de passe, couleur), la répartition par défaut et un éventuel solde d'ouverture.
|
|
|
|
Les variables `DATABASE_URL` / `TEST_DATABASE_URL` de `.env` ne servent qu'au développement local ; elles sont ignorées par la stack de production.
|
|
|
|
## Mise à jour
|
|
|
|
```bash
|
|
git pull
|
|
docker compose up -d --build
|
|
```
|
|
|
|
Les migrations de la base s'appliquent automatiquement au démarrage du conteneur `app`.
|
|
|
|
## Sauvegardes
|
|
|
|
- Le service `backup` fait un dump compressé de la base **au démarrage puis chaque nuit à 03:00** (heure de Paris)
|
|
dans `./backups/finances-AAAA-MM-JJ_HHMM.sql.gz`. Les dumps de plus de **30 jours** sont supprimés.
|
|
- La VM entière est par ailleurs sauvegardée par Proxmox Backup Server.
|
|
- Vérifier les sauvegardes : `ls -lh backups/` et `docker compose logs backup`.
|
|
|
|
### Restaurer un dump
|
|
|
|
```bash
|
|
docker compose stop app
|
|
gunzip -c backups/finances-AAAA-MM-JJ_HHMM.sql.gz \
|
|
| docker compose exec -T db sh -c 'mariadb -u root -p"$MARIADB_ROOT_PASSWORD" finances'
|
|
docker compose start app
|
|
```
|
|
|
|
## Mot de passe oublié
|
|
|
|
Chacun change son propre mot de passe dans **Réglages**. En cas d'oubli :
|
|
|
|
```bash
|
|
docker compose exec app node dist/reset-password.js <identifiant> <nouveau-mot-de-passe>
|
|
```
|
|
|
|
## Développement local
|
|
|
|
```bash
|
|
npm install
|
|
cp .env.example .env # garder les variables de la section « Développement local », ajouter SESSION_SECRET
|
|
docker compose -f docker-compose.dev.yml up -d # MariaDB sur le port 3307 (bases finances et finances_test)
|
|
npx prisma migrate dev
|
|
npm run db:seed
|
|
npm run dev # http://localhost:3000
|
|
npm test # tests unitaires + intégration (base finances_test)
|
|
```
|
|
|
|
Organisation du code :
|
|
|
|
- `src/domain/` : règles de calcul pures et testées (centimes entiers, répartitions en points de base) :
|
|
équilibre entre personnes, flux mensuels, charges nettes, budgets, amortissement, récurrences.
|
|
- `src/server/` : accès base (Prisma), authentification, services métier (`services/`) et Server Actions (`actions/`).
|
|
- `src/app/` : pages (tableau de bord, opérations, récurrents & prévu, budgets, crédits, réglages).
|
|
- `docs/superpowers/specs/` : document de conception ; `docs/superpowers/plans/` : plan d'implémentation.
|