Installation Edu Framework ?¶

L'installation va se faire en ligne de commande via un terminal (git-bash, iterm, warp, tabby ...)

Choisir son emplacement de projet¶

Utilisez la commande "cd" pour naviguer dans votre arborescence de fichiers et sélectionner l'emplacement de votre projet.

cd NOM_DU_DOSSIER // pour avancer dans votre arboresence
cd .. // pour reculer
pwd // pour savoir ou vous êtes dans votre arboresence

Création du projet¶

Nous allons créer le projet à l'aide du gestionnaire de paquets "composer". Cette étape vous permettra de construire la base du projet en une seule ligne de commande.

Saisir cette commande dans votre terminal :

Information importante

Remplacez NOM_DU_PROJET par le nom de votre projet

composer create-project studoo/edu-framework-skeleton NOM_DU_PROJET

Erreur d'intallation du projet

Attention, cette commande peut comporter des erreurs si vous n'avez pas installé PHP.

Voir le chapitre "Erreur d'intallation du projet"

Exemple d'affichage suite à la commande

Ce résultat est un exemple et il ne sera probablement pas le vôtre.

Creating a "studoo/edu-framework-skeleton" project at "./NOM_DU_PROJET"
Installing studoo/edu-framework-skeleton (X.0.0)
  - Downloading studoo/edu-framework-skeleton (X.0.0)
  - Installing studoo/edu-framework-skeleton (X.0.0): Extracting archive
Created project in /Users/redbull/Projects/studoo/NOM_DU_PROJET
Loading composer repositories with package information
Updating dependencies
Lock file operations: 9 installs, 0 updates, 0 removals
  - Locking graham-campbell/result-type (X.1.x-dev 60c5f57)
    [...]
  - Locking vlucas/phpdotenv (dev-master 1a7ea2a)
Writing lock file
Installing dependencies from lock file (including require-dev)
Package operations: 9 installs, 0 updates, 0 removals
  - Installing symfony/polyfill-php80 (X.x-dev 6caa573): Extracting archive
    [...]
  - Installing studoo/edu-framework (dev-main c5cd9c5): Extracting archive
Generating autoload files
7 packages you are using are looking for funding.
Use the `composer fund` command to find out more!
No security vulnerability advisories found

Il est important de connaitre les étapes d'installation. Cela va vous permettre de comprendre en cas de problème d'installation.

Creating "studoo/edu-framework-skeleton" Création d'un dossier temporaire
Installing "studoo/edu-framework-skeleton" Téléchargement et installation du skeleton edu-framework
Created project Création du dossier de votre projet dans votre arborescence de fichier
Loading composer Lecture de votre fichier composer.json sur la partie "require" (liste des librairies)
Updating dependencie Etude des dépendances de librairie (package)
Writing lock file Ecriture du fichier composer.lock pour verrouiller les versions des librairies.
Installing dependencie Installation des "vendor". C'est un dossier ou l'ensemble des librairies sont installées
Generating autoload files Ecriture du fichier "/vendor/autoload.php" qui inclut l'ensemble des librairies.
[...] Résultat de toutes les opérations. Des messages d'alerte concernant les mises à jour peuvent être générés dans cette section.

Erreur d'intallation du projet¶

Si vous rencontrez des erreurs lors de l'installation du projet, voici quelques explications pour vous aider :

The openssl extension is required for SSL/TLS protection but is not availab
  le. If you can not enable the openssl extension, you can disable this error
  , at your own risk, by setting the 'disable-tls' option to true.

Voir le chapitre "Activer l'extension OpenSSL"

Cannot use studoo/edu-framework-skeleton's latest version v1.3.0 as it requires ext-mbstring * which is missing from your platform.

In CreateProjectCommand.php line 421:

  Could not find package studoo/edu-framework-skeleton with stability stable in a version installa
  ble using your PHP version, PHP extensions and Composer version.

Voir le chapitre "Activer l'extension mbstring"

Initialiser votre projet¶

Le projet vient de s'installer, la prochaine étape est d'initialiser les fichiers de configuration.

Vous devez rentrer dans votre projet, via la commande "cd"

Nom du projet

Remplacez NOM_DU_PROJET par le nom de votre projet

cd NOM_DU_PROJET

Puis, saisir cette commande dans votre terminal :

composer edu:init

Fichier .env

Un fichier .env va être créé à la racine de votre projet. Il contient l'ensemble des variables d'environnement de votre projet.

Erreur de démarrage¶

Si vous démarrez votre serveur applicatif sans le fichier ".env" (Dotenv), voici le message d'erreur :

Fatal error: Uncaught Dotenv\Exception\InvalidPathException: 
Unable to read any of the environment file(s) at [...]

Erreur d'installation des dépendances¶

Au moment de la commande "composer create-project studoo/edu-framework-skeleton ...", vous pouvez rencontrer des erreurs d'installation des dépendances.

Voici un exemple de message d'erreur :

Problem 1
- Root composer.json requires studoo/edu-framework dev-main, found studoo/edu-framework[dev-dev, v0.2.1, ..., v0.6.0, v1.0.0, ..., 1.4.x-dev] but it does not match the constraint.

Pour résoudre ce problème, plusieurs solutions s'offrent à vous : - vous devez supprimer le fichier "composer.lock" et relancer la commande "composer install" - vous devez mettre à jour la version de votre projet dans le fichier "composer.json" et relancer la commande "composer install"

Dans le fichier composer.json, vous devez modifier la ligne suivante :

"require": {
-     "studoo/edu-framework": "dev-main"
+     "studoo/edu-framework": "2.x-dev"
}