Getting Started
Installation
Prérequis et lancement du projet en local.
Installation
Prérequis
- Docker et Docker Compose
- Node.js 20+
- pnpm
Ajouter également ces entrées dans /etc/hosts pour résoudre les domaines locaux:
127.0.0.1 trickspin.dev
127.0.0.1 api.trickspin.dev
Lancer le projet en local
1. Cloner le dépôt
git clone https://github.com/Charline-Heuguet/TrickSpin
2. Variables d'environnement
Copier les fichiers d'exemple et renseigner les valeurs :
cp back/.env.example back/.env
cp front/.env.example front/.env
3. Démarrer les conteneurs
make up
Pour rebuilder les images avant de démarrer :
make build
4. Accès aux conteneurs
make api # Entrer dans le conteneur back (Symfony)
make front # Entrer dans le conteneur front (Nuxt)
5. Base de données
Lancer les migrations :
make migrate
Importer les données métier :
make import-grabs
make import-combos
Les grabs doivent être importés avant les combos (certains combos y font référence).
L'import des combos lit back/combos.csv (source de vérité) et synchronise la base : upsert par slug, catégories, difficulté, grab.
La documentation détaillée est disponible dans Import des combos.
Une fois le projet initialisé, l'application est accessible sur https://trickspin.dev et l'API sur https://api.trickspin.dev.
URLs locales
| Service | URL |
|---|---|
| Frontend | http://localhost:3000 |
| API | https://localhost |
Commandes utiles
| Commande | Description |
|---|---|
make down | Arrêter les conteneurs |
make reset | Reset complet avec suppression des volumes |
make logs | Voir tous les logs |
make logs-back | Logs du backend uniquement |
make logs-front | Logs du frontend uniquement |
make sf cmd=cache:clear | Exécuter une commande Symfony |
make db | Accéder à MySQL |
make db-dump | Exporter la base de données |