Skip to content

betagouv/itou

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Itou - Les emplois de l'inclusion

Les emplois de l'inclusion est un service numérique de délivrance des PASS IAE et de mise en relation d'employeurs solidaires avec des candidats éloignés de l'emploi par le biais de tiers (prescripteurs habilités, orienteurs) ou en autoprescription.

Environnement de développement

Définition des variables d'environnement

Commencez par copier le gabarit du fichier de configuration Django prévu pour le développement :

cp config/settings/dev.py.template config/settings/dev.py

Les valeurs par défaut de dev.py permettent de lancer un environnement fonctionnel.

Cependant, il est recommandé d'en prendre connaissance pour noter par exemple que les emails ne sont pas réellement envoyés mais que leur contenu est simplement écrit dans la sortie standard.

Le reste de la configuration se fait avec des variables d'environnement. Deux fichiers de configuration, dev.env et secrets.env doivent être créés :

cp envs/dev.env.template envs/dev.env
cp envs/secrets.env.template envs/secrets.env

Le fichier dev.env contient les variables d'environnement dont la valeur peut être partagée et pour lesquelles la valeur définie par défaut est viable pour un environnement de développement.

À l'inverse, le fichier secrets.env regroupe les variables propres à votre environnement et par nature « sensible ». Ces variables n'ont donc pas de valeur par défaut viable et doivent donc être configurées par vos soins.

Développement avec Docker

Vous devez disposer sur votre machine d'un démon Docker et de l'outil Docker Compose. Si ce n'est pas encore le cas :

Vous pouvez également personnaliser la configuration Compose en créant un fichier .env à partir d'une copie du fichier racine .env.template. Le fichier .env doit être au même niveau que le fichier README.md.

Développement dans un Virtualenv

Créez votre environnement avec vos commandes habituelles, par exemple python -m venv <votrevenv itou> ou mkvirtualenv itou.

Les dépendances peuvent êtres installées via pip install -r requirements/dev.txt.

Lancer le serveur de développement

Avec Docker :

$ make run

# Équivalent de :
$ docker-compose up

Ou pour utiliser un débogueur interactif type ipdb :

$ docker-compose run --service-ports django

Une fois votre serveur de développement lancé, vous pouvez accéder au frontend à l'adresse http://localhost:8080/.

Dans un Virtualenv, vous pouvez utiliser les commandes Django habituelles (./manage.py) mais également certaines recettes du Makefile, celles-ci seront lancées directement dans votre venv si USE_VENV=1 est utilisé. Cette variable devrait normalement pouvoir être définie en global dans votre environnement shell (export, .env, ...).

Peupler la base de données

$ make populate_db

Créer un compte admin

A noter qu'il existe déjà (juste après le populate_db) un compte super-utilisateur: admin@test.com / password

$ make shell_on_django_container
$ django-admin createsuperuser

Avant un commit

$ make quality  # Will run black, isort, and flake8

Données de test

Voir notre documentation interne.

Front-end