ynerant/plateforme-corres2math
1
0
Fork 0
mirror of https://gitlab.com/animath/si/plateforme-corres2math.git synced 2024-12-03 17:26:53 +00:00
Code Issues Releases Wiki Activity
369 Commits 2 Branches 0 Tags 2 MiB
Python 72.7%
HTML 26.9%
Dockerfile 0.3%
Shell 0.1%
master
Go to file
Yohann D'ANELLO 4c9e63be3d Merge branch 'improvements' into 'master' 
Questions can be seen during the third phase

See merge request animath/si/plateforme-corres2math!11
2021-01-08 12:42:44 +00:00
apps Merge branch 'improvements' into 'master' 2021-01-08 12:42:44 +00:00
corres2math Add copyright information 2020-12-26 21:26:26 +01:00
locale/fr/LC_MESSAGES Add about page 2020-12-22 21:30:34 +01:00
.bashrc Setup models and database 2020-09-21 17:53:07 +02:00
.gitignore Exclude whoosh index 2020-10-30 19:55:24 +01:00
.gitlab-ci.yml Tests should not depend on Matrix-nio, that uses lxml that needs a lot of dependencies and a lot of time to build 2020-11-03 20:52:55 +01:00
corres2math.cron Rebuild search index each hour 2020-12-21 18:01:11 +01:00
Dockerfile django-cas-server does not support Django 3.1 and Python 3.9 yet 2020-12-22 23:24:15 +01:00
entrypoint.sh Migrate in the entrypoint, not in the docker build 2020-11-04 13:51:41 +01:00
index.html Copie du site du TFJM² à adapter aux Correspondances 2019-09-10 01:48:52 +02:00
LICENSE Add copyright information 2020-12-26 21:26:26 +01:00
manage.py Restart the project in Django 2020-09-20 22:31:37 +02:00
nginx_corres2math.conf Increase nginx upload limit to have a better message in the Django form 2020-12-22 20:40:01 +01:00
README.md Update README 2020-11-02 11:12:28 +01:00
requirements.txt django-cas-server does not support Django 3.1 and Python 3.9 yet 2020-12-22 23:24:15 +01:00
tox.ini Remove django cas server in CI dependencies 2020-11-03 21:10:21 +01:00

README.md

Plateforme des Correspondances des Jeunes Mathématicien·nes

pipeline status coverage report

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.

Cette plateforme permet aux participants et encadrants de s'inscrire et de déposer leurs autorisations nécessaires. Ils pourront ensuite déposer leurs solutions et notes de synthèse pour le premier tour en temps voulu. La plateforme offre également un accès pour les organisateurs et les jurys leur permettant de communiquer avec les équipes et de récupérer les documents nécessaires.

Un wiki plus détaillé arrivera ultérieurement. L'interface organisateur et jury est vouée à être plus poussée.

L'instance de production est disponible à l'adresse inscription.correspondances-maths.fr.

Installation

Le plus simple pour installer la plateforme est d'utiliser l'image Docker incluse, qui fait tourner un serveur Nginx exposé sur le port 80 avec le serveur Django. Ci-dessous une configuration Docker-Compose, à adapter selon vos besoins :

  plateforme-corres2math:
    build: https://gitlab.com/animath/si/plateforme-corres2math.git
    links:
      - postgres
    ports:
      - "80:80"
    env_file:
      - ./inscription-corres2math.env
    volumes:
    # - ./inscription-corres2math:/code
      - ./inscription-corres2math/media:/code/media

Le volume /code n'est à ajouter uniquement en développement, et jamais en production.

Il faut remplir les variables d'environnement suivantes :

CORRES2MATH_STAGE=              # dev ou prod
DJANGO_DB_TYPE=                 # MySQL, PostgreSQL ou SQLite (par défaut)
DJANGO_DB_HOST=                 # Hôte de la base de données
DJANGO_DB_NAME=                 # Nom de la base de données
DJANGO_DB_USER=                 # Utilisateur de la base de données
DJANGO_DB_PASSWORD=             # Mot de passe pour accéder à la base de données
SMTP_HOST=                      # Hôte SMTP pour l'envoi de mails
SMTP_PORT=465                   # Port du serveur SMTP
SMTP_HOST_USER=                 # Utilisateur 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
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 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 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.

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.