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 depuis le CSV :

make import-tricks

Les données structurelles du projet sont injectées par les migrations SQL, tandis que la liste des tricks est importée depuis back/tricks.csv via la commande Symfony dédiée. L'import synchronise la base avec le CSV: les tricks présents dans le fichier sont créés ou mis à jour, et la description des tricks déjà existants est ajustée si elle change dans le CSV. La documentation détaillée de ce flux est disponible dans Import des tricks.

Une fois le projet initialisé, l'application est accessible sur https://trickspin.dev et l'API sur https://api.trickspin.dev.

URLs locales

ServiceURL
Frontendhttp://localhost:3000
APIhttps://localhost

Commandes utiles

CommandeDescription
make downArrêter les conteneurs
make resetReset complet avec suppression des volumes
make logsVoir tous les logs
make logs-backLogs du backend uniquement
make logs-frontLogs du frontend uniquement
make sf cmd=cache:clearExécuter une commande Symfony
make dbAccéder à MySQL
make db-dumpExporter la base de données