Bénéfriches est un outil numérique développé au sein de l'incubateur de l'ADEME.
Son object est de fournir une solution de calcul des impacts positifs de la reconversion de friches aux chargés d’opération d’aménagement pour favoriser la prise de décision (pour tout type de projet d’aménagement) et augmenter le nombre de reconversions.
L'outil est actuellement en phase de construction.
L'application est intégralement codée en Typescript. L'API est construite sur la plateforme NodeJS avec le framework NestJS. L'application web est construite avec les bibliothèques React et Redux.
Les données sont stockées dans une base PostgreSQL.
Le projet est organisé en monorepo et géré avec le gestionnaire de packages pnpm
.
- node (version 20 ou supérieure)
- pnpm (version 8.6 ou supérieur)
- docker (optionnel)
- postgresql (si docker non installé)
pnpm install
docker compose --env-file apps/api/.env -f docker-compose.db.yml up -d # lancement de la base de données
pnpm --filter api knex:migrate-latest # lancement des migrations
pnpm --filter api knex:seed-run # chargement des données nécessaires à l'application
Utilisation des valeurs exposées dans apps/web/.env.example
et apps/api/.env.example
.
cp apps/web/.env.example apps/web/.env
cp apps/api/.env.example apps/api/.env
pnpm --filter api start:dev
pnpm --filter web setup-env-vars
pnpm --filter web dev
pnpm run -r test
pnpm run -r lint
pnpm run -r format:check
pnpm run -r typecheck
pnpm run -r build