Installation
Guide d'installation d'Aaperture pour le développement local.
Prérequis
- Node.js : Version 20.19 ou supérieure (voir
.nvmrc) - PostgreSQL : Version 14 ou supérieure
- Redis : Version 6 ou supérieure (optionnel mais recommandé)
- Docker : Pour le développement local (recommandé)
Installation Rapide
1. Cloner le Repository
git clone https://github.com/aaperture/aaperture.git
cd aaperture
2. Configuration de l'Environnement
Copiez le fichier .env.example vers .env :
cp .env.example .env
Éditez .env et configurez les variables nécessaires (voir Variables d'Environnement (racine du dépôt)).
Alternative si vous stockez vos secrets locaux dans Proton Pass :
make env-local-from-proton \
PROTON_PASS_ENV_ITEM="aaperture/local-env" \
PROTON_PASS_ENV_CMD='pass-cli item view --item-title "{item}" --field note'
Puis synchronisez :
make sync-env
Si votre compte Proton Pass n'a pas encore l'accès CLI, utilisez temporairement un export local :
make env-local-from-proton \
PROTON_PASS_ENV_CMD='cat ~/Downloads/aaperture-local.env'
3. Installation des Dépendances
npm install
4. Synchronisation de l'Environnement
make sync-env
5. Démarrage avec Docker
Méthode recommandée (rapide) - si les containers existent déjà :
npm run dev
Cette commande démarre les services sans rebuild et ouvre le navigateur.
Première fois ou après modifications :
npm run dev:rebuild
Cette commande rebuild les images Docker puis démarre les services.
Rebuild complet (supprime volumes et rebuild) :
npm run dev:clean
6. Migrations de Base de Données
make migrate
7. Accès à l'Application
L'application sera accessible sur :
- Frontend : https://localhost:5173
- Backend API : https://localhost:8080
Commandes Utiles
Gestion des Services
| Commande | Description |
|---|---|
npm run dev | Démarrage rapide (sans rebuild) |
npm run dev:rebuild | Rebuild + démarrage |
npm run dev:clean | Clean + rebuild + démarrage |
npm run stop | Arrêter les services |
npm run status | Voir l'état des services |
npm run logs | Voir les logs |
Commandes Make Avancées
| Commande | Description |
|---|---|
make quick | Démarrage rapide sans rebuild |
make dev | Rebuild et démarrage |
make stop | Arrêter les services |
make down | Arrêter et supprimer les containers |
make logs | Logs de tous les services |
make logs-api | Logs du backend uniquement |
make logs-web | Logs du frontend uniquement |
make status | État des services avec healthchecks |
make shell-api | Shell dans le container backend |
make shell-web | Shell dans le container frontend |
make db-shell | Shell PostgreSQL |
make redis-cli | CLI Redis |
make restart-api | Redémarrer le backend |
make restart-web | Redémarrer le frontend |
make rebuild-api | Rebuild uniquement le backend |
make clean-rebuild | Supprimer volumes + rebuild |
make clean-all | Nettoyage complet (volumes, images, cache) |
Vérification de l'Installation
- Ouvrez https://localhost:5173 dans votre navigateur
- Acceptez le certificat auto-signé (pour le développement local)
- Connectez-vous avec Google OAuth
Dépannage
Problèmes de Certificat HTTPS
Pour macOS, ajoutez le certificat aux certificats de confiance :
sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain infra/caddy-data/caddy/pki/authorities/local/root.crt
Redémarrez votre navigateur après avoir ajouté le certificat.
Problèmes de Base de Données
Vérifiez que PostgreSQL est bien démarré :
docker ps | grep postgres
Problèmes de Port
Si les ports 5173 ou 8080 sont déjà utilisés, modifiez-les dans docker-compose.yml.
Prochaines Étapes
- Quick Start - Créez votre première session
- Architecture (racine du dépôt) - Comprenez l'architecture