betagouv / urbanvitaliz-django

Outil support UrbanVitaliz basé sur le framework django

UrbanVitaliz

Mission

UrbanVitaliz est une équipe projet portée par le Cerema, en partenariat avec Beta.gouv.fr, et sponsorisé par le Ministère de la Transition Ecologique et l'Etablissement Public Foncier du Nord-Pas-de-Calais.

L'objectif est de créer un service public gratuit d'appui aux petites collectivités pour la reconversion des friches, en lien avec les objectifs de sobriété foncière du gouvernement.

Logiciel

Le logiciel RECO-CO est l'outil support pour les collectivités et les conseiller·ère·s.

Il est réalisé en python/django côté moteur et alpinejs/bootstrap/dsfr côté interface.

Son code est couvert par la licence AGPL v3.0.

En savoir plus sur http://urbanvitaliz.fr

Installation

Deux choix :

1. Via virtualenv et pip3
2. Via Docker

Virtualenv

TODO

Docker

Les fichiers docker se trouvent à la racine dans le dossier docker.

Création du conteneur

En ligne de commandes, aller dans ce dossier et taper :

docker-compose up

Après quelques minutes d'installation, vous devriez avoir un environnement prêt à configurer.

Installation des dépendances

Entrez dans le container app en tapant :

docker-compose exec app /bin/bash

Rendez-vous dans le dossier /workspace et installez les dépendances à l'aide de :

pip3 install -r requirements.txt
pip3 install -r requirements-dev.txt

Puis, installez les dépendances javascript :

cd urbanvitaliz/frontend
yarn install

Configuration de l'applicatif

Copiez le fichier de configuration d'exemple :

cp urbanvitaliz/settings/development.py.example urbanvitaliz/settings/development.py

Puis modifiez la configuration de la base de données :

DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.postgresql',
         'NAME': os.environ.get('POSTGRES_NAME'),
         'USER': os.environ.get('POSTGRES_USER'),
         'PASSWORD': os.environ.get('POSTGRES_PASSWORD'),
         'HOST': 'db',
         'PORT': 5432,
     }
}

Création de la base de donnnées

Synchronisez la base de données en tapant depuis workspace :

./manage.py migrate

Lancement de l'applicatif

Pour lancer l'applicatif en mode développement, générez les statiques à l'aide de :

cd urbanvitaliz/frontend && yarn dev

(Laissez la commande ouverte)

Puis, exécutez le backend :

./manage.py runserver 0.0.0.0:8000

Vous devriez pouvoir vous connecter sur http://localhost:8000 !

En cas de difficultés

Dans le cas où vous rencontrez une difficulté, n'hésitez pas à ouvrir une issue sur GitHub, nous vous répondrons dans les plus brefs délais !