Configuration locale de l'API
Ce guide vous accompagne dans la configuration de l'API ChurchApps pour le développement local. Vous allez cloner le dépôt, configurer les connexions à la base de données, initialiser le schéma et démarrer le serveur de développement avec rechargement à chaud.
Avant de commencer
- Installez Node.js 24+, Git et MySQL 8.0+ -- voir Prérequis
- Créez un utilisateur MySQL disposant des privilèges de création de bases de données
- Consultez la référence des variables d'environnement pour la configuration de l'API
Étapes détaillées de la configuration
1. Cloner le dépôt
git clone https://github.com/ChurchApps/Api.git
2. Installer les dépendances
Le projet utilise Yarn (une protection bloque npm install) :
cd Api
yarn install
3. Configurer les variables d'environnement
cp .env.sample .env
Ouvrez .env et configurez les chaînes de connexion à MySQL. Chaque module a besoin de sa propre connexion à la base de données, au format suivant :
mysql://root:password@localhost:3306/dbname
Vous aurez besoin des chaînes de connexion des six bases de données des modules (membership, attendance, content, giving, messaging, doing).
4. Initialiser les bases de données
npm run initdb
Cette commande crée automatiquement les six bases de données et leurs tables.
Vous pouvez initialiser la base de données d'un seul module avec npm run initdb -- --module=membership (ou attendance, content, giving, messaging, doing).
5. Démarrer le serveur de développement
npm run dev
L'API démarre avec rechargement à chaud à l'adresse http://localhost:8084.
Commandes principales
| Commande | Description |
|---|---|
npm run dev | Démarrer le serveur de développement avec rechargement à chaud (tsx watch) |
npm run build | Nettoyer, compiler le TypeScript et copier les ressources |
npm run test | Exécuter les tests avec Jest (avec couverture) |
npm run test:watch | Exécuter les tests en mode surveillance |
npm run lint | Exécuter ESLint avec correction automatique (ESLint est le seul formateur) |
Déploiement
L'environnement de préproduction a été retiré. L'API se déploie dans l'environnement de démonstration à chaque envoi vers main, et en production par le flux de travail manuel Deploy Prod, qui applique aussi les migrations de base de données en attente. Voir Déploiement de l'API pour plus de détails.
Développement local des bibliothèques
Si vous devez développer une bibliothèque partagée (@churchapps/helpers ou @churchapps/apihelper) en parallèle de l'API, compilez-la dans l'espace de travail Packages et ajoutez un portail Yarn temporaire dans l'API :
# Dans l'espace de travail Packages
yarn build
# Dans le répertoire de l'API
yarn link ../Packages/helpers
# ... tester ...
yarn unlink ../Packages/helpers && yarn install
Cela vous permet de tester les modifications de bibliothèque avec l'API sans publier sur npm. Voir Bibliothèques partagées pour plus de détails -- et ne committez jamais la résolution du portail que le lien écrit dans package.json.
Articles connexes
- Base de données -- Comprendre l'architecture d'une base par module
- Structure des modules -- Comment les contrôleurs, les référentiels et les modèles sont organisés
- Bibliothèques partagées -- Travailler avec
@churchapps/helperset@churchapps/apihelper