@tricoteuses/droits-et-demarches
v0.3.1
Published
Library, web API & site to browse "Vos droits et démarches" open data from French Direction de l'information légale et administrative (Dila)
Downloads
5
Readme
Tricoteuses Droits et démarches
Library, Web API & site to browse Service-public.fr "Vos droits et démarches" open data from French Direction de l'information légale et administrative (Dila)
Tricoteuses Droits et démarches is free and open source software.
Vos droits et démarches data sources:
- https://www.dila.premier-ministre.gouv.fr/repertoire-des-informations-publiques/les-donnees-administratives
- https://www.data.gouv.fr/fr/datasets/service-public-fr-guide-vos-droits-et-demarches-particuliers/
- https://www.data.gouv.fr/fr/datasets/service-public-fr-guide-vos-droits-et-demarches-entreprendre/
- https://lecomarquage.service-public.fr/vdd/3.3/part/
- https://lecomarquage.service-public.fr/vdd/3.3/pro/
Installation
Create database
Using Debian GNU/Linux, install PostgreSQL, then:
sudo su - postgres
createuser droits_et_demarches -P # and enter the password
createdb -O droits_et_demarches droits_et_demarches
psql droits_et_demarches
CREATE EXTENSION IF NOT EXISTS pg_trgm;
\q
exit
Install dependencies
npm install
Server Configuration
Create a .env
file to set configuration variables (you can use example.env
as a template). Then:
npm run configure
Datasets Initialization
mkdir -p ../dila-data/vos_droits_et_demarches/part
cd ../dila-data/vos_droits_et_demarches/part
git init
git branch -m main
cd -
mkdir -p ../dila-data/vos_droits_et_demarches/pro
cd ../dila-data/vos_droits_et_demarches/pro
git init
git branch -m main
cd -
Datasets Update, Cleaning, Repair & Conversion From XML To JSON
Particuliers Dataset Update, Cleaning, Repair & Conversion From XML To JSON
Particuliers Dataset Update
cd ../dila-data/vos_droits_et_demarches/part/
git switch main
git pull
# Download XML.
cd ../../../tricoteuses-droits-et-demarches/
npx tsx src/scripts/download_droits_et_demarches.ts part --commit --push
cd ../dila-data/vos_droits_et_demarches/part/
Particuliers Dataset Cleaning
git branch -d nettoyage
git switch -c nettoyage
cd ../../../tricoteuses-droits-et-demarches/
npx tsx src/scripts/repair_droits_et_demarches.ts part
cd ../dila-data/vos_droits_et_demarches/part/
git add .
git commit -m "Nettoyage automatique par script repair_droits_et_demarches"
git push -f origin nettoyage
Particuliers Dataset Repair
git switch corrections
git rebase nettoyage
# Manually handle eventual conflicts, then:
git push -f origin corrections
Particuliers Dataset Conversion From XML To JSON
cd ../dila-data/vos_droits_et_demarches/part_json/
git switch main
git pull
cd ../../../tricoteuses-droits-et-demarches/
npx tsx src/scripts/convert_droits_et_demarches_to_json.ts part --commit --push --strict
cd ../dila-data/vos_droits_et_demarches/part/
Professionnels Dataset Update, Cleaning, Repair & Conversion From XML To JSON
Professionnels Dataset Update
cd ../dila-data/vos_droits_et_demarches/pro/
git switch main
git pull
# Download XML.
cd ../../../tricoteuses-droits-et-demarches/
npx tsx src/scripts/download_droits_et_demarches.ts pro --commit --push
cd ../dila-data/vos_droits_et_demarches/pro/
Professionnels Dataset Cleaning
git branch -d nettoyage
git switch -c nettoyage
cd ../../../tricoteuses-droits-et-demarches/
npx tsx src/scripts/repair_droits_et_demarches.ts pro
cd ../dila-data/vos_droits_et_demarches/pro/
git add .
git commit -m "Nettoyage automatique par script repair_droits_et_demarches"
git push -f origin nettoyage
Professionnels Dataset Repair
git switch corrections
git rebase nettoyage
# Manually handle eventual conflicts, then:
git push -f origin corrections
Professionnels Dataset Conversion From XML To JSON
cd ../dila-data/vos_droits_et_demarches/part_json/
git switch main
git pull
cd ../../../tricoteuses-droits-et-demarches/
npx tsx src/scripts/convert_droits_et_demarches_to_json.ts pro --commit --push --strict
cd ../dila-data/vos_droits_et_demarches/pro/
Database Update
npx tsx src/scripts/import_droits_et_demarches.ts
Server Launch
In development mode:
npm run dev
In production mode:
npm run build
npm run preview
Development
JSON Schemas Generation
npx tsx src/scripts/generate_droits_et_demarches_json_schemas.ts
# Prettify generated JSON file.
npm run format