From 7b9e7b826300c2d449eac55360146fb192d0cb8c Mon Sep 17 00:00:00 2001
From: nono <social@n07070.xyz>
Date: Thu, 6 Jan 2022 16:06:13 +0100
Subject: [PATCH] =?UTF-8?q?D=C3=A9but=20de=20mise=20=C3=A0=20jour=20du=20R?=
=?UTF-8?q?EADME?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++-----
1 file changed, 51 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index f911807..80505bd 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,51 @@
+# Site de Don de La Quadrature Du Net
+
+Ce site web, écrit en PHP avec le framework Fat-Free-Framework permet de gérer les donnations et les contreparties pour La Quadrature Du Net. ( English below )
+
+## Conception
+
+## Installation
+
+Vous aurez besoin de ;
+
+- Un serveur Linux ( Debian de préférence ), avec...
+ - PHP 7.4+
+ - Mysql/MariaDB
+
+### En production
+
+#### Serveur web
+
+#### Connection à la banque
+
+#### Gestion
+
+### En test
+
+Afin de faciliter les test, nous avons inclus un fichier Vagrant, qui permet de lancer une machine virtuelle pré-configurée avec toutes les dépendances nécessaire pour tester le site de don, à l'exception du mode de banque pour le moment, mais rien n'empêche que vous le mettiez en place.
+
+Afin de lancer la machine de développement, vous pouvez ;
+
+- Installer Vagrant si ce n'est pas déjà fait,
+- Lancer `vagrant up`. Ça prendra un peu de temps la première fois.
+- Vous avez maintenant une machine virtuelle accessible via ssh avec `vagrant ssh`, et vous pouvez voir le site de don sur `localhost:8383`.
+- Vous pouvez faire vos modifications directement dans le dossier du dépôt, car il est lié sur la machine virtuelle, sous le chemin `/vagrant`.
+
+## Développement
+
+## Contributions
+
+Les contributions sont bienvenues ! Pour commencer, vous pouvez regarder les tickets ouvert sur le dépôt. Certaines sont marqués comme étant "besoin d'aide", et ne demandent que vous pour être résoluts !
+
+Afin de faciliter le développement collaboratif, vous pouvez commencer par commenter le ticket qui vous intéresse, et expliquer ce que vous comptez faire.
+
+Sinon, vous pouvez aussi ouvrir un ticket pour proposer des améliorations, des suggestions, ou autre.
+
+Vous pouvez ensuite ouvrir une merge request, et une fois relue, elle sera mise en place ! À ce stade, merci beaucoup :)
+
+----
+
+
# LQDN soutien
This is a php application based on Fat-Free-Framework and a MySQL database that handles donations and presents offered to donors to La Quadrature du Net
@@ -45,9 +93,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 +104,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 +119,3 @@ location / {
try_files $uri /index.php$is_args$args;
}
```
-
-
--
GitLab