README.md

Résorption-bidonvilles
Agir pour résorber les bidonvilles

[Sources de la plateforme]
Consulter le wiki »

Voir la plateforme · Contribuer au développement · Déployer une instance

🤓 Préambule

Ce dépôt est un monorepo, c'est à dire qu'il contient les sources de plusieurs applicatifs distincts et séparés dans le dossier /packages :

• le package frontend : le frontend de la plateforme, une SPA développée avec VueJS
• le package api : l'API REST qui alimente le frontend, développée avec NodeJS (Express)

🛠 Pré-requis

• le dépôt resorption-bidonvilles-deploy, correctement installé et configuré pour une instance de développement
• nodejs (14.x)
• yarn (1.22.x)

🔌 Initialisation

Une fois ce dépôt clôné sur votre machine :

• installez les dépendances communes à tous les packages : yarn install
• installez les dépendances internes des packages via l'outil lerna : yarn lerna bootstrap

Cette courte initialisation permet :

• d'installer toutes les dépendances techniques nécessaires
• de configurer les pre-commit et pre-push hooks grâce à l'outil husky

Vous êtes prêt(e)s à travailler !

🙇🏼 Contributeur(ices)

Anis Safine Laget	Christophe Bénard	Gaël Destrem	Grégoire Thomazeau	Gilles Cognin

📝 Licence

Ce projet est distribué sous license AGPL-3.0.