Site Web du GIP de l'inclusion

Prérequis

• Python (version)
• docker
• docker-compose
• uv

Installer les pre-commit hooks

pre-commit install

On peut faire un premier test en faisant tourner :

pre-commit run --all-files

Installation

Le projet peut se lancer en local ou avec Docker.

En local

Lancer les containers

docker-compose up

Définir les variables d'environnement

cp .env.example .env
$EDITOR .env

Créer un environnement virtuel

# Configurer et activer l'environnement virtuel
uv venv
. .venv/bin/activate
uv pip sync --require-hashes requirements.txt

Copier les variables d'environnement

cp .env.example .env

Configurer le bucket

python manage.py configure_bucket

Lancer le serveur

python manage.py runserver

Lancer les migrations

python manage.py migrate

Effectuer les tests

Les tests unitaires peuvent être lancés avec make test-units, les tests E2E avec make test-e2e, les deux avec make test.

Pour les tests E2E, si vous n'utilisez pas Docker, il vous faudra Firefox et geckodriver accessibles sur votre machine pour lancer les tests E2E. Sur MacOS, vous pouvez les installer via brew avec la commande: brew install geckodriver.

Vous pouvez également générer un rapport sur la couverture de tests :

coverage run manage.py test --settings config.settings_test

Mettre à jour les paquets Python

uv pip compile --generate-hashes requirements.in -o requirements.txt

Premier lancement

Pour initialiser le site avec notamment la page d'accueil au bon format :

python manage.py loaddata cms/fixtures/fixtures.json