tricoteuses-legifrance/README.md

2.5 KiB

Tricoteuses Legal Explorer

Tricoteuses Legal Explorer is free and open source software.

Legal data sources:

Main definitions used by these data: https://www.legifrance.gouv.fr/contenu/Media/files/lexique-api-lgf.docx

Installation

Create database

Using Debian GNU/Linux, install PostgreSQL, then:

sudo su - postgres
createuser legi -P # and enter the password
createdb -O legi legi
psql legi
  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/dole
cd ../dila-data/dole
git init
cd -
npx tsx src/scripts/download_dila_dataset.ts dole

mkdir -p ../dila-data/jorf
cd ../dila-data/jorf
git init
cd -
npx tsx src/scripts/download_dila_dataset.ts jorf

mkdir -p ../dila-data/kali
cd ../dila-data/kali
git init
cd -
npx tsx src/scripts/download_dila_dataset.ts kali

mkdir -p ../dila-data/legi
cd ../dila-data/legi
git init
cd -
npx tsx src/scripts/download_dila_dataset.ts legi

Datasets Update

npx tsx src/scripts/download_dila_dataset.ts dole ../dila-data/
npx tsx src/scripts/download_dila_dataset.ts jorf ../dila-data/
npx tsx src/scripts/download_dila_dataset.ts kali ../dila-data/
npx tsx src/scripts/download_dila_dataset.ts legi ../dila-data/

Database Update

npx tsx src/scripts/import_dole.ts ../dila-data/
npx tsx src/scripts/import_jorf.ts ../dila-data/
npx tsx src/scripts/import_kali.ts ../dila-data/
npx tsx src/scripts/import_legi.ts ../dila-data/

Server Launch

In development mode:

npm run dev

In production mode:

npm run build
npm run preview

Package Generation & Publishing

npm version patch # or major or minor
npm run package
npm publish ./package