ynerant/plateforme-tfjm2
1
0
Fork 0
mirror of https://gitlab.com/animath/si/plateforme.git synced 2024-12-27 05:42:24 +00:00
Code Issues Releases Wiki Activity
385 Commits 3 Branches 0 Tags 11 MiB
Python 73.1%
HTML 22.4%
TeX 4.1%
Dockerfile 0.3%
d9a2b31606
Go to file
Yohann D'ANELLO d9a2b31606
Django filters was missing
2021-01-23 13:43:31 +01:00
apps Fix matrix avatar 2021-01-23 13:41:43 +01:00
docs Prepare documentation on /doc 2021-01-20 15:00:26 +01:00
locale/fr/LC_MESSAGES Fix the permission to see a user page 2021-01-23 11:02:26 +01:00
tfjm Django filters was missing 2021-01-23 13:43:31 +01:00
.bashrc Smaller bashrc 2020-09-19 21:31:11 +02:00
.dockerignore Reset project 2020-12-27 11:14:35 +01:00
.gitignore Commit migrations, they should not be too much updated 2020-12-28 19:28:53 +01:00
.gitlab-ci.yml Don't use external libraries when running tests 2020-12-28 19:12:07 +01:00
Dockerfile Texlive is missing in the docker image 2021-01-21 22:51:12 +01:00
entrypoint.sh Clone Corres2math platform 2020-12-27 11:49:54 +01:00
LICENSE Clone Corres2math platform 2020-12-27 11:49:54 +01:00
manage.py Clone Corres2math platform 2020-12-27 11:49:54 +01:00
nginx_tfjm.conf Prepare documentation on /doc 2021-01-20 15:00:26 +01:00
README.md Clone Corres2math platform 2020-12-27 11:49:54 +01:00
requirements.txt Detect when a solution has more than 30 pages 2021-01-19 00:32:34 +01:00
tfjm.cron Generate authorization templates as PDF 2021-01-21 21:44:43 +01:00
tox.ini Install PyPDF3 in test environment 2021-01-19 00:38:21 +01:00

README.md

Plateforme du TFJM²

pipeline status coverage report

La plateforme du TFJM² est née pour la dixième é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.tfjm.org.

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-tfjm:
    build: https://gitlab.com/animath/si/plateforme-tfjm.git
    links:
      - postgres
    ports:
      - "80:80"
    env_file:
      - ./inscription-tfjm.env
    volumes:
    # - ./inscription-tfjm:/code
      - ./inscription-tfjm/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 :

TFJM_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@tfjm.org     # Nom de l'expéditeur des mails
SERVER_EMAIL=contact@tfjm.org   # 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.