tricoteuses-legifrance/README.md

# Tricoteuses Legal Explorer

## _Web API & site to browse legal open data from French Direction de l'information légale et administrative (Dila)_

_Tricoteuses Legal Explorer_ is free and open source software.

- [software repository](https://git.en-root.org/tricoteuses/tricoteuses-legal-explorer)
- [GNU Affero General Public License version 3 or greater](https://git.en-root.org/tricoteuses/tricoteuses-legal-explorer/blob/master/LICENSE.md)

## Installation

### Create database

Using Debian GNU/Linux, install PostgreSQL, then:

```sh
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

```sh
npm install
```

## Server Configuration

Create a `.env` file to set configuration variables (you can use `example.env` as a template). Then:

```sh
npm run package
npm run configure
```

## Server Launch

In development mode:

```sh
npm run dev
```

In production mode:

```sh
npm run build
npm run preview
```