Installation du projet se fait via les outils composer et git.
Dans un premier temps, il faut faire un fork du repository sur votre espace de travail
Puis cloner le projet sur votre machine
Une fois que la commande "git clone" est effectué, vous devez créer votre fichier de configuration projet (dotenv)
Ce fichier doit s'appeler ".env", vous pouvez partir du fichier exemple nommé ".env.example"
Une fois les fichiers crées, vous pouvez adapter les valeurs des variables définies
cp _.env.example .env && cp app/_.env.example app/.env
La prochaine étape concerne l'installation des librairies du projet. Cette installation se fait par l'outil "composer".
Composer est un gestionnaire de package. Son utilité est assurée la compatibilité et l'installation entre les différentes versions de librairie.
cd app && composer install && cd ..
La base de donnée est un fichier sql. Elle se trouve dans le répertoire "docs/app_db.sql" Vous pouvez l'importer dans votre gestionnaire de base de donnée (phpmyadmin, mysql workbench, ...)
Démarrer docker
docker compose up -d
Demarrer ton projet via le serveur PHP
cd app && composer start && cd ..
Le projet est accessible via l'url suivante : http://localhost:8042
La base de donnée est accessible via l'url suivante : http://localhost:8081
Le mailcatcher est accessible via l'url suivante : http://localhost:1080
docker compose down
En cas de création ou de mise a jour des classes du projet, faire la commande de autoloader
$ cd app && composer dump-autoload && cd ..
Version | Service | DESCRIPTION |
---|---|---|
^5.5 | vlucas/phpdotenv | Loads environment variables |
^3.5 | twig/twig | Template Engine (VIEW couch) |
^1.3 | nikic/fast-route | Router Engine (CONTROLLER couch) |
^8.0 | PHP Engine | Engine PHP |
^2.0 | Composer | Dependency Manager |
^9.5 | PHPUnit | Testing Engine |
Les tests unitaires sont réalisés via PHPUnit.
cd app && composer test && cd ..