Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 2.34 KB

dev.md

File metadata and controls

67 lines (43 loc) · 2.34 KB

Guide du développeur

Contribuer

  • Les Issues servent à documenter, discuter et suivre les bugs ou idées d'améliorations
  • La branche principale est master
  • Ouvrir une Pull Request (PR) pour tout changement de code :
    • en essayant de les garder petites (quite à faire 2 ou 3 PR pour une grosse fonctionnalité)
    • en préférant le Français (l'application est actuellement seulement disponible dans cette langue)
    • en donnant un titre clair (il apparaitra dans le contenu de la release)
    • quand la PR est acceptée le contributeur est libre de merger
    • un squash est effectué au moment du merge, pour garder un historique facilement lisible

Modèle de données

Voir la page wiki Organisation de la base de donnée.

Stack technique

Symfony

Materialize

mailcatcher

Permet de visualiser les mails envoyés en local.

http://localhost:1080

Docker

Un docker-compose.yml existe pour permettre le développement sous Docker. Suivez le guide d'installation.

N'oubliez pas de définir la variable d'environnement DEV_MODE_ENABLED dans le container qui exécute le code de l'application.

Nix

Vous pouvez obtenir toutes les dépendances du projet en utilisant Nix. Une fois installé lancez nix develop --impure et tous les outils nécessaires sont dans votre PATH à la bonne version, comme déclaré dans flake.nix. Cela peut se faire automatiquement quand vous cd dans le répertoire si vous avez installé direnv.

Pour lancer l'instance mariadb de test utilisez devenv up. Pour lancer l'application, utilisez php bin/console server:run '*:8000'

Tests

// créer la base de donnée de test + initialiser avec le schema
docker exec -i php php bin/console --env=test doctrine:database:create
docker exec -i php php bin/console --env=test doctrine:schema:create
// lancer les tests
docker exec -i php php ./vendor/bin/phpunit

Logs

En local

// voir les 100 dernières lignes
tail -100 var/logs/dev.log