ophelios/zephyrus-framework

Template project for Zephyrus foundation.

dev-main 2024-09-05 17:58 UTC

Requires

• php: >=8.2
• ext-curl: *
• ext-dom: *
• ext-fileinfo: *
• ext-gd: *
• ext-intl: *
• ext-json: *
• ext-libxml: *
• ext-posix: *
• ext-ssh2: *
• ext-zip: *
• ophelios/zephyrus: 0.7.0
• symfony/var-dumper: *
• twilio/sdk: ^6.0
• vlucas/phpdotenv: ^5.5

Requires (Dev)

• phpunit/phpunit: 10.*
• tracy/tracy: ^2.10

MIT

• David Tucker

README

Projet destiné à être utilisé comme base de gabarit pour les projets ZEPHYRUS.

Environnement de développement (Docker)

Prérequis

Assurez-vous d'avoir le Moteur Docker installé et à jour.

Premier démarrage

Copiez le fichier .env.docker vers un fichier nommé .env. Ensuite, entrez votre jeton GitHub pour la variable d'environnement GITHUB_ACCESS_TOKEN. Lancez finalement la construction de l'environnement de développement.

docker compose up
docker exec -it zephyrus_webserver composer install

Mise à jour des dépendances (Composer)

docker exec -it foundation_webserver composer update

Redémarrer la base de données (au besoin)

docker compose down
docker compose up

Activer / Désactiver Xdebug

Par défaut, xdebug est installé, mais pas actif pour augmenter les performances en développement. Par contre, il est possible de l'activer et de le désactiver avec une commande. Doit être exécuté sur l'ordinateur hôte et non depuis le conteneur Docker (puisque le script interagit avec l'exécutable de Docker sur l'hôte).

Activer

composer xdebug-enable

Désactiver

composer xdebug-disable

MailCatcher

Par défaut, l'image Docker fourni avec Zephyrus inclus MailCatcher. Ceci permet de tester des courriels simplement.

Pour accéder à MailCatcher : http://localhost:1080/

mailer:
  transport: "smtp"
  from_address: "[e-mail]"
  from_name: "Zephyrus"
  smtp:
    enabled: true
    host: "localhost"
    port: 1025
    encryption: "none"
    username: ""
    password: ""

Génération de la cache Latte

docker exec -it foundation_webserver composer latte-cache

Supprimer les images Docker

docker rmi $(docker images -q)