ynerant/plateforme-corres2math
1
0
Fork 0
mirror of https://gitlab.com/animath/si/plateforme-corres2math.git synced 2024-12-05 02:06:52 +00:00
Code Issues Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Yohann D'ANELLO 2020-11-02 11:12:28 +01:00
parent dd1238d44d
commit a707219a9e
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,7 +1,7 @@
# Plateforme d'inscription des Correspondances des Jeunes Mathématicien·nes # Plateforme des Correspondances des Jeunes Mathématicien·nes
[![pipeline status](https://gitlab.com/animath/si/plateforme-corres2math/badges/django/pipeline.svg)](https://gitlab.com/animath/si/plateforme-corres2math/-/commits/django) [![pipeline status](https://gitlab.com/animath/si/plateforme-corres2math/badges/master/pipeline.svg)](https://gitlab.com/animath/si/plateforme-corres2math/-/commits/master)
[![coverage report](https://gitlab.com/animath/si/plateforme-corres2math/badges/django/coverage.svg)](https://gitlab.com/animath/si/plateforme-corres2math/-/commits/django) [![coverage report](https://gitlab.com/animath/si/plateforme-corres2math/badges/master/coverage.svg)](https://gitlab.com/animath/si/plateforme-corres2math/-/commits/master)
La plateforme des Correspondances des Jeunes Mathématicien·nes est née pour la seconde édition en 2019 de l'action. La plateforme des Correspondances des Jeunes Mathématicien·nes est née pour la seconde édition en 2019 de l'action.
D'abord codée en PHP, elle a subi une refonte totale en Python, à l'aide du framework Web [Django](https://www.djangoproject.com/). D'abord codée en PHP, elle a subi une refonte totale en Python, à l'aide du framework Web [Django](https://www.djangoproject.com/).
@ -21,8 +21,8 @@ Le plus simple pour installer la plateforme est d'utiliser l'image Docker inclus
exposé sur le port 80 avec le serveur Django. Ci-dessous une configuration Docker-Compose, à adapter selon vos besoins : exposé sur le port 80 avec le serveur Django. Ci-dessous une configuration Docker-Compose, à adapter selon vos besoins :
```yaml ```yaml
inscription-corres2math: plateforme-corres2math:
build: ./inscription-corres2math build: https://gitlab.com/animath/si/plateforme-corres2math.git
links: links:
- postgres - postgres
ports: ports:
@ -51,17 +51,20 @@ SMTP_HOST_USER= # Utilisateur du compte SMTP
SMTP_HOST_PASSWORD= # Mot de passe du compte SMTP SMTP_HOST_PASSWORD= # Mot de passe du compte SMTP
FROM_EMAIL=contact@correspondances-maths.fr # Nom de l'expéditeur des mails FROM_EMAIL=contact@correspondances-maths.fr # Nom de l'expéditeur des mails
SERVER_EMAIL=contact@correspondances-maths.fr # Adresse e-mail expéditrice SERVER_EMAIL=contact@correspondances-maths.fr # Adresse e-mail expéditrice
SYMPA_URL=lists.example.com # Serveur Sympa à utiliser
SYMPA_EMAIL= # Adresse e-mail du compte administrateur de Sympa
SYMPA_PASSWORD= # Mot de passe du compte administrateur de Sympa
SYNAPSE_PASSWORD= # Mot de passe du robot Matrix
``` ```
Si le type de base de données sélectionné est SQLite, la variable `DJANGO_DB_HOST` sera utilisée en guise de chemin vers Si le type de base de données sélectionné est SQLite, la variable `DJANGO_DB_HOST` sera utilisée en guise de chemin vers
le fichier de base de données (par défaut, `db.sqlite3`). le fichier de base de données (par défaut, `db.sqlite3`).
En développement, il est recommandé d'utiliser SQLite pour des raisons de simplicité. Les paramètres de mail ne seront En développement, il est recommandé d'utiliser SQLite pour des raisons de simplicité. Les paramètres de mail ne seront
pas utilisés, et les mails qui doivent être envoyés seront envoyés dans la console. pas utilisés, et les mails qui doivent être envoyés seront envoyés dans la console. Les intégrations mail et Matrix
seront également désactivées.
En production, il est recommandé de ne pas utiliser SQLite pour des raisons de performances. En production, il est recommandé de ne pas utiliser SQLite pour des raisons de performances.
La dernière différence entre le développment et la production est qu'en développement, chaque modification d'un fichier La dernière différence entre le développment et la production est qu'en développement, chaque modification d'un fichier
est détectée et le serveur se relance automatiquement dès lors. est détectée et le serveur se relance automatiquement dès lors.
Une fois le site lancé, le premier compte créé sera un compte administrateur.