diff --git a/README.md b/README.md index f911807dbdd0a01de51b6899432021d2b0315105..0a932868ed44f9299006c3b17aafab7c67c4577f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,22 @@ This is a php application based on Fat-Free-Framework and a MySQL database that It's used as our primary donation platform, and uses our bank's payment system (cheaper) to get one-time or recurring payments recorded into the donation platform. +## Environnement de test + +Afin de faciliter la réalisation de tests, vous pouvez utiliser Vagrant et Ansible à travers le rôle `don-lqdn`. + +Pour la mise en place ; + +- Mise en place de la machine virtuelle ; téléchargement d'une machine virtuelle Debian. + - `$ vagrant up` +- Installation du site de don ; Installation du rôle don-lqdn dans la machine virtuelle + - `$ vagrant provision` +- Vous pouvez maintenant voir le site de don sur `http://localhost:8383`. + +Les modifications faites dans ce dossier sont reportés directement dans la machine virtuelle, dans son dossier `/home/don/don`. + +Vous pouvez modifier ceci en éditant le fichier `Vagrantfile` et les fichiers dans le dossier `ansible/`. + ## Installation (quick) In order to install this project, run `make doctor` to check that everything is fine. @@ -45,9 +61,9 @@ and for developers you may also need : This software uses: * **PHP7.3** -* **phinx** to inject database schema and initial data / accounts into MySQL see https://phinx.org/ +* **phinx** to inject database schema and initial data / accounts into MySQL see https://phinx.org/ * **php-cs-fixer** to check php code for errors and fix coding standard issues, see https://github.com/FriendsOfPHP/PHP-CS-Fixer -* **doctrine/dbal** as ORM see https://github.com/doctrine/dbal +* **doctrine/dbal** as ORM see https://github.com/doctrine/dbal * **f3 framework** as main view / controller framework. see https://fatfreeframework.com/ Look at `app/` folder for most Controllers, and `app/routes.ini` for the application routes (the URLs) @@ -56,7 +72,7 @@ Look at `app/` folder for most Controllers, and `app/routes.ini` for the applica * `app/env` must contains the proper values : database connection, bank visa payment codes, and ENV=production at the bottom. * point your Nginx or Apache with PHP5.6 to the `www/` folder, and either allow Rewrite Rules (a2enmod rewrite) or point every URL not being a file to index.php (see below for an nginx sample) -* use AND FORCE https usage, it's 2018, people ;) +* use AND FORCE https usage, it's 2018, people ;) Nginx configuration sample: @@ -71,5 +87,3 @@ location / { try_files $uri /index.php$is_args$args; } ``` - -