02 - Symfony : Installation et Initialisation d'un projet Symfony

Objectifs

• ✅ Créer un projet Symfony
• ✅ Utiliser la console de Symfony
• ✅ Versionner ton projet avec Git

Pré-requis

​

1. 1

   Terminer les quêtes suivantes

   Quêtes liées

   • Quête 329
   • Quête 912
2. 2

   Savoir utiliser le gestionnaire de dépendances Composer

   Quêtes liées

   • Quête 1149

Introduction

Ça y est, après la phase de conception et de découverte de Symfony, tu vas enfin pouvoir commencer à entrer dans le code !

Pour commencer simplement, tu vas créer un projet vierge, le configurer et le versionner. Évidemment, c’est ce même projet qu’il faudra réutiliser à chaque nouvelle quête Symfony pour, qu’à la fin de ta formation, ton Wild Series soit finalisé !

Sommaire

Installation et initialisation d'un projet Symfony

Tout d'abord, tu vas commencer par créer un nouveau projet Symfony

Avant toute chose, assure-toi que tu disposes bien de PHP 8.2 minimum, ainsi que de Composer, auquel cas tu trouveras un lien dans les ressources qui s'y réfère ou n'hésite pas à regarder tes anciennes quêtes PHP.

Si tout est bon, place-toi à l'endroit où tu souhaites réaliser cette quête dans ton arborescence de fichiers, comme par exemple :

cd ~/workspace/quetes/symfony

Evidemment, il faut que ces dossiers existent !

Installation de Symfony CLI

Si c’est la toute première fois que tu initialises un projet Symfony sur ce PC, il faut que tu récupères l’outil d’installation de Symfony et l’installes globalement. Cette opération te permettra ensuite d’utiliser la commande symfony dans ton terminal.

Tu trouveras différents onglets en fonction de ton OS (Linux, MacOS, Windows) en suivant le lien ci-dessous.

Enfin, vérifie que tu as correctement installé le client symfony en exécutant la commande suivante dans ton terminal :

symfony -v

Tu devrais avoir une sortie proche de cela dans ton terminal (le numéro de version et le nom des commandes peuvent être différents car Symfony CLI est activement développé et évolue rapidement)

Symfony CLI version 5.8.16 (c) 2021-2024 Fabien Potencier (2024-04-23T14:40:41Z - stable)
Symfony CLI helps developers manage projects, from local code to remote infrastructure

These are common commands used in various situations:

Work on a project locally

  new                                                            Create a new Symfony project
  server:start                                                   Run a local web server
  server:stop                                                    Stop the local web server
  security:check                                                 Check security issues in project dependencies
  composer                                                       Runs Composer without memory limit
  console                                                        Runs the Symfony Console (bin/console) for current project
  php, pecl, pear, php-fpm, php-cgi, php-config, phpdbg, phpize  Runs the named binary using the configured PHP version

Manage a project on Cloud

  init                Initialize a new project using templates
  cloud:domains       Get a list of all domains
  cloud:branch        Branch an environment
  cloud:environments  Get a list of environments
  cloud:push          Push code to an environment
  cloud:ssh           SSH to the current environment
  cloud:projects      Get a list of all active projects
  cloud:tunnel:open   Open SSH tunnels to an app's relationships
  cloud:user:add      Add a user to the project
  cloud:variables     List variables

Show all commands with symfony help,
Get help for a specific command with symfony help COMMAND.

✨ Création d'un nouveau projet

Pour créer un nouveau projet, tu peux maintenant lancer la commande

symfony new --webapp wild-series --version=lts

Patiente quelques instants… Symfony CLI télécharge les librairies et configure un nouveau projet, qui aura ici pour nom "wild-series" et qui utilisera la dernière version stable du framework.

Une fois ton projet initialisé, il faut lancer ton serveur HTTP pour pouvoir lire tes fichiers PHP / Symfony. Comme expliqué par Symfony, tu peux :

• soit lancer le serveur PHP web local depuis le répertoire du projet Symfony via la commande :

  sh

  php -S 127.0.0.1:8000 -t public/
  

• soit utiliser le serveur de Symfony qui est préconisé pour le développement et que tu vas découvrir juste après.

🌐 Lancer le serveur web Symfony

Le framework Symfony vient avec tout un tas de commandes qui vont te simplifier la vie (tu auras le temps de les découvrir dans les quêtes suivantes). En utilisant ton terminal de commande comme tu le faisais jusqu'à présent pour jouer avec Git, PHP ou composer, tu vas pouvoir utiliser des directives propres à Symfony.

Par exemple, pour lancer le serveur durant la phase de développement, exécute la commande ci-dessous à la racine de ton projet (après t'y être déplacé cd wild-series 😉) :

symfony server:start 

Il existe une option qui lance ton serveur en tâche de fond: -d. Cela te permet de réutiliser ton terminal directement après avoir lancé ton serveur:

symfony server:start -d

Pour ouvrir l'URL du serveur en cours dans ton navigateur (par ex localhost:8000), tu peux utiliser la commande

symfony open:local

Afin de pouvoir stopper ton serveur fonctionnant en mode détaché, une autre commande est à ta disposition:

symfony server:stop

Voici la page que tu devrais avoir (à un numéro de version près) :

📂 Structure d'un projet Symfony

Sans que tu t'en rendes compte, Symfony a fait pas mal de choses. Dans le dossier wild-series, tu trouveras un ensemble de fichiers et de dossiers qui constitue l'architecture de ton projet Symfony. On y trouve tous les outils nécessaires pour construire une plateforme sur des bases saines et solides. Jette un œil à la ressource ci-dessous pour connaître le rôle de ces dossiers.

🗄️ Versionner son projet avec Git

Il ne manque pas une étape dans notre installation ?

Eh si, il nous reste à versionner notre projet par le biais de Git !

Sache que lorsque tu installes un projet Symfony, celui-ci est déjà pensé pour Git. En effet, tu trouveras dans la plupart des dossiers des fichiers .gitignore qui excluront les fichiers à ne pas versionner. Tu peux éventuellement jeter un œil sur le .gitignore principal, à la racine de ton projet.

Symfony a déjà effectué un git init pour toi et ton projet contient un fichier de configuration .git/config par défaut. Il te faut alors simplement configurer ton dépôt distant (remote origin).

git remote add origin git@github.com:User/YourRepoName.git

Bien évidemment, remplace l'URL par celle de ton repository créé au préalable sur Github.

Tu peux ensuite effectuer ton premier commit :

git status
git branch -M main
git push -u origin main

Le git status ici te montre juste quels sont les fichiers qu'il faut absolument versionner.

Installer un projet Symfony existant

Quand tu récupères un projet existant, c'est le plus souvent en utilisant git clone. Le dossier récupéré contient déjà toute l'infrastructure de dossiers de Symfony. Mais attention, il va te manquer un certain nombre de fichiers et de dossiers, notamment ceux ignorés dans le .gitignore.

Par exemple, le dossier vendor/ (généré par Composer), est ignoré. C'est sûrement le plus gros dossier du projet, car il contient les bibliothèques utilisées par l'application.

Pour récupérer ce dossier, tu devras donc lancer la commande suivante depuis la racine du projet :

cd wild-series/
composer install

Tu peux ensuite reprendre les étapes du dessus. Par la suite, tu auras éventuellement à personnaliser le fichier .env (en le dupliquant en .env.local) puisqu'il contient des données sensibles qui te sont propres (comme tes identifiants de base de données).

💪 Challenge

Initialisation du projet Wild Series 🍿

Le défi est simple :

Crée un nouveau projet Symfony Web pour ton Wild Series et push ton projet sur Github. Copie l’URL de ce dépôt git dans le champ solution.

Critères de validation

• Le dépôt contient les dossiers suivants  : bin/, config/, public/, src/, templates/, tests/, translations/ et quelques autres fichiers (.gitignore, composer.json, etc.).

• Le dépôt ne contient pas de répertoires ou fichiers listés dans .gitignore, comme .idea/, .vscode/, .DS_Store et vendor/.