improve readme

This commit is contained in:
Yannick Le Duc
2025-08-27 14:04:32 +02:00
parent a8d341e633
commit c94c8038f3

View File

@@ -9,7 +9,7 @@ Une application web moderne et éthique pour gérer des campagnes de budgets par
**Mes Budgets Participatifs** est conçue pour démocratiser la prise de décision budgétaire. Elle permet aux organisations, associations, collectifs et institutions de : **Mes Budgets Participatifs** est conçue pour démocratiser la prise de décision budgétaire. Elle permet aux organisations, associations, collectifs et institutions de :
- **Impliquer les citoyens** dans les décisions budgétaires - **Impliquer les citoyens** dans les décisions budgétaires
- **Transparence totale** sur l'utilisation des fonds - Utilisation de l'**intelligence collective** sur l'utilisation des fonds
- **Démocratie participative** accessible à tous - **Démocratie participative** accessible à tous
- **Gestion éthique** des données et de la vie privée - **Gestion éthique** des données et de la vie privée
@@ -145,13 +145,6 @@ Créez un fichier `.env.local` à la racine du projet :
NEXT_PUBLIC_SUPABASE_URL=votre_url_supabase NEXT_PUBLIC_SUPABASE_URL=votre_url_supabase
NEXT_PUBLIC_SUPABASE_ANON_KEY=votre_cle_anon_supabase NEXT_PUBLIC_SUPABASE_ANON_KEY=votre_cle_anon_supabase
SUPABASE_SERVICE_ROLE_KEY=votre_cle_service_supabase SUPABASE_SERVICE_ROLE_KEY=votre_cle_service_supabase
# Configuration email (optionnelle)
SMTP_HOST=smtp.votre-provider.com
SMTP_PORT=587
SMTP_USER=votre_email@domaine.com
SMTP_PASS=votre_mot_de_passe
SMTP_FROM=votre_email@domaine.com
``` ```
**⚠️ Important :** La `SUPABASE_SERVICE_ROLE_KEY` est **obligatoire** pour les opérations d'administration. Elle permet d'effectuer des opérations privilégiées côté serveur (création d'utilisateurs, gestion des campagnes, etc.). **⚠️ Important :** La `SUPABASE_SERVICE_ROLE_KEY` est **obligatoire** pour les opérations d'administration. Elle permet d'effectuer des opérations privilégiées côté serveur (création d'utilisateurs, gestion des campagnes, etc.).
@@ -165,14 +158,20 @@ SMTP_FROM=votre_email@domaine.com
``` ```
3. **Connectez-vous** avec les identifiants créés 3. **Connectez-vous** avec les identifiants créés
### 5. Lancer l'application ### 5. Configuration email (optionnelle)
Une fois connecté à l'administration, vous pouvez configurer les paramètres SMTP via l'interface :
1. Allez dans **Paramètres** > **Configuration SMTP**
2. Renseignez vos paramètres de serveur SMTP
3. Testez la configuration
### 6. Lancer l'application
```bash ```bash
npm run dev npm run dev
``` ```
L'application sera accessible sur `http://localhost:3000` L'application sera accessible sur `http://localhost:3000`
### 6. Tests (optionnel) ### 7. Tests (optionnel)
```bash ```bash
# Lancer les tests fonctionnels # Lancer les tests fonctionnels
npm run test:working npm run test:working
@@ -264,7 +263,7 @@ npm run test:coverage
- **Prix** : À partir de 5€/mois - **Prix** : À partir de 5€/mois
- **Site** : [alwaysdata.com](https://alwaysdata.com) - **Site** : [alwaysdata.com](https://alwaysdata.com)
#### 🌍 **Solutions libres et éthiques internationales** #### 🌍 **Autres solutions possibles** (liste non exhaustive)
##### 5. **Render** (États-Unis) ##### 5. **Render** (États-Unis)
- **Avantages** : Déploiement automatique, base de données PostgreSQL - **Avantages** : Déploiement automatique, base de données PostgreSQL
@@ -304,13 +303,6 @@ npm run test:coverage
NEXT_PUBLIC_SUPABASE_URL=votre_url_supabase_production NEXT_PUBLIC_SUPABASE_URL=votre_url_supabase_production
NEXT_PUBLIC_SUPABASE_ANON_KEY=votre_cle_anon_supabase_production NEXT_PUBLIC_SUPABASE_ANON_KEY=votre_cle_anon_supabase_production
SUPABASE_SERVICE_ROLE_KEY=votre_cle_service_supabase_production SUPABASE_SERVICE_ROLE_KEY=votre_cle_service_supabase_production
# Configuration email (optionnelle)
SMTP_HOST=smtp.votre-provider.com
SMTP_PORT=587
SMTP_USER=votre_email@domaine.com
SMTP_PASS=votre_mot_de_passe
SMTP_FROM=votre_email@domaine.com
``` ```
#### Commandes de build #### Commandes de build