Skip to content

Latest commit

 

History

History
235 lines (168 loc) · 9.46 KB

README.md

File metadata and controls

235 lines (168 loc) · 9.46 KB
Raw

Upont 4.0

Refonte de uPont en python avec le framework django pour une meilleure accessibilité aux nouveaux développeurs.

  • framework back-end django
  • framework front-end mixte Jinja2 et ReactJS
  • base de données PostgreSQL

Site de développement

Ancien repository

Installation

Pour construire les images des conteneurs :

docker-compose build

Pour lancer le site en local (commandes docker-compose standard, version 1.29.2) :

docker-compose up -d

Site accessible au port 8000 : (configurable dans le fichier .env)

$BROWSER localhost:8000

Installation des pre-commit hooks :

pip install pre-commit
pre-commit install

Commandes Django

Accès à la DB par docker exec :

docker exec -it $(docker ps -f 'name=db' --format '{{.ID}}') psql -U upont

Pour les commandes python, commencer par entrer dans le conteneur :

docker-compose exec back /bin/sh

Remplir la base de données avec des données de test :

python manage.py loaddata upont/fixtures/populate.json

Ajouter un administrateur :

python manage.py createsuperuser

Créer les migrations :

python manage.py makemigrations

Appliquer les migrations :

python manage.py migrate

Mise en production

À l'intérieur du container back, nginx reçoit les requêtes et les transmet à gunicorn, qui se charge de faire le lien avec le serveur python.

Lancer le build :

bash scripts/build.sh

Lancer le serveur :

bash scripts/start.sh

Stopper le serveur :

bash scripts/stop.sh

Sauvegarde

Une sauvegarde du site consiste en une copie des données de la base données et une copie des médias (image de profil, images liées à des posts ou des events).

Base de données

Réaliser une sauvegarde de la base de données

# bash scripts/backup_database.sh

La sauvegarde se trouve dans le dossier backups/database sous le nom AnnéeMoisJourHeureMinute.dump.

Attention bien vérifier que les valeurs de DB_USER et DB_NAME dans le script sont les bonnes !

Restaurer une sauvegarde de la base de données

On commence par renter dans le container de la base de données :

$ docker-compose exec db /bin/bash

On restaure les données de la sauvegarde :

# pg_restore -d $DB_NAME -U $DB_USER --clean save.dump

Attention cette commande supprime le contenu actuel de la base de données pour le remplacer par celui de la sauvegarde

Medias

Réaliser une sauvegarde des médias

# bash scripts/backup_media.sh

La sauvegarde se trouve dans le dossier backups/media sous le nom AnnéeMoisJourHeureMinute.tar.gz.

Restaurer une sauvegarde des medias

On commence par rentrer dans le container du back :

$ docker-compose exec bash /bin/bash

On supprime les anciens médias :

# rm -r /src/media/*

On extrait la sauvegarde :

# tar -xf save.tar.gz -C /src/media

Variables d'environnement

Les variables d'environnement suivantes sont placées dans le fichier .env :

Variable Description Dev Prod
DB_HOST Nom du host de la BDD. db db
DB_PORT Port de la BDD (interne au container). 5432 5432
DB_USER Utilisateur de la BDD. upont upont
DB_NAME Nom de la BDD. upont upont
DB_PASSWORD Mot de passe de la BDD. upont SECRET
BACK_PORT Port d'accès au site (externe). 8000 ****
SENDGRID_API_KEY Clé permettant d'envoyer des mails avec l'API sendgrid (à récupérer sur le site de Sendgrid). key SECRET
ADMIN_EMAIL Adressse recevant les mails d'administration de Django pour alertir de certaines actions (création d'un compte...). [email protected] Autre
DEFAULT_FROM_EMAIL Adresse envoyant les mails (avec Sendigrd, n'importe quelle adresse en @enpc.org fonctionne). [email protected] [email protected]
SECRET_KEY Clé secrète utilisée par Django. ChangeThatPlease SECRET
DEBUG Défini si le mode DEBUG est activé. True False
DOMAIN_NAME Nom de domaine utilisé en production. Toutes les requêtes ne provenant pas de ce domaine seront rejetées. upont.enpc.org upont.enpc.org
GUNICORN_NB_WORKERS Nombre de workers pour le WSGI gunicorn. 10
SECURE_SSL_REDIRECT Redirige automatiquement les requêtes non HTTPS vers des requêtes HTTPS. Laisser à False si un autre proxy fait déjà cete redirection. False False
REMOTE_STATIC_STORAGE Variable indiquant si le site utilise un serveur distant pour servir les fichiers statiques. False True
FTP_STORAGE_LOCATION URL de connexion FTP au serveur de stockage distant pour y placer les fichiers statiques. ftp://<user>:<password>@<host>:<port>
REMOTE_STATIC_URL URL pour l'accès aux fichiers statiques distants (peut être différent de FTP_STORAGE_LOCATION). https://upont.cdn.enpc.org

Commande pour générer une clé secrète (vous devez avoir Django installé):

python3 -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())'

Workflow git

Toujours travailler sur une nouvelle branche :

git checkout dev
git branch feature
git checkout feature

Ajouter vos changements :

git add ...
git commit -m "Nom de commit explicite"

Mettre la branche en ligne et créer une pull request :

git push --set-upstream origin feature

Méthode 1 :

Quand un reviewer a validé la pull request et que les checks sont réussis, faire un rebase de la nouvelle branche dans dev :

git checkout feature
git rebase dev

Faire un rebase de dev dans la feature (on pourra faire un rebase interactif pour squash plusieurs commits):

git checkout dev
git rebase feature

Mettre les changements en ligne :

git checkout dev
git push

Méthode 2 :

Sur la page de la pull request, utiliser github pour résoudre les conflits en ligne et pour "squash & merge".

Documentation

Documentation du site :

Les indispensables :

Autres technologies utilisées :

  • Pour uniformiser la syntaxe sur le projet : pre-commit
  • Gestionnaire de dépendances python : Poetry
  • Gestionnaire de dépendances javascript : npm
  • Application WSGI pour la mise en production : Gunicorn
  • Serveur web et reverse-proxy : Nginx
  • Base de données : PostgreSQL
  • Intégration continue : Github Actions
  • Bundler javascript : webpack