Lexicon REST API

Français | English

Français

Note : ce projet est une interface web pour Lexicon. Veuillez consulter son dépôt si vous souhaitez contribuer à la base de données.

Pour contribuer au Lexicon, voir CONTRIBUTING.md

I. Commencer

Prérequis : installer Bun

Bun s'installe par utilisateur dans ~/.bun — pas d'écriture système, désinstallable en supprimant ce dossier. Aucune dépendance Node.js, Docker ou gestionnaire de versions n'est requise.

# Linux / macOS
$ curl -fsSL https://bun.sh/install | bash

# Windows (PowerShell)
$ powershell -c "irm bun.sh/install.ps1 | iex"

Vérifiez l'installation (rouvrez le terminal si la commande n'est pas trouvée) :

$ bun --version

Plus de détails : bun.sh.

1. Cloner le dépôt

$ git clone https://github.com/osfarm/lexicon-rest-api.git

2. Remplir le fichier d'environnement avec vos identifiants

$ cd ./lexicon-rest-api
$ cp .env.example .env
$ nano .env

Structure du fichier .env :

HOST=0.0.0.0
PORT=8888
DB_HOST=lexicon.osfarm.org
DB_PORT=5432
DB_USER=your_user
DB_PASSWORD=your_password
DB_NAME=lexicon
DB_SCHEMA=lexicon__6_0_0-ekyviti

3. Installer les dépendances

$ bun upgrade && bun install

4. Démarrer le serveur

$ bun start

5. Accéder à l'application en local

Une fois le serveur démarré, ouvrez votre navigateur et accédez à :

http://localhost:8888

II. Hypermedia par conception

L'API REST Lexicon est RESTful, ce qui signifie qu'elle est conçue avec l'hypermedia en tête.

Non seulement une même ressource peut être affichée dans différents formats, mais la perte d'information entre les formats est minimale : quel que soit le format de sortie choisi, les données sont enrichies avec des libellés, des traductions, des interprétations et des hyperliens.

Le format de sortie peut être modifié en ajoutant une extension à un chemin :

• /phytosanitary/products
• /phytosanitary/products.json
• /phytosanitary/products.csv

---

English

Note: This project is a web interface for Lexicon. Please check its repository if you want to contribute to the database.

To contribute to Lexicon, see CONTRIBUTING.md

I. Getting Started

Prerequisite: install Bun

Bun installs per-user under ~/.bun — no system writes, uninstall by removing that directory. No Node.js, Docker or version manager required.

# Linux / macOS
$ curl -fsSL https://bun.sh/install | bash

# Windows (PowerShell)
$ powershell -c "irm bun.sh/install.ps1 | iex"

Verify the installation (reopen your terminal if the command is not found):

$ bun --version

More details: bun.sh.

1. Clone the repository

$ git clone https://github.com/osfarm/lexicon-rest-api.git

2. Populate the environment file with your credentials

$ cd ./lexicon-rest-api
$ touch .env
$ nano .env

Structure of the .env file:

HOST=0.0.0.0
PORT=8888
DB_HOST=lexicon.osfarm.org
DB_PORT=5432
DB_USER=your_user
DB_PASSWORD=your_password
DB_NAME=lexicon
DB_SCHEMA=lexicon__6_0_0-ekyviti

3. Install dependencies

$ bun upgrade && bun install

4. Start the server

$ bun start

5. Access the application locally

Once the server is started, open your browser and navigate to:

http://localhost:8888

II. Hypermedia by Design

The Lexicon REST API is RESTful, which means it is designed with hypermedia in mind.

Not only can the same resource be displayed in different formats, but information loss between formats is minimal: regardless of the chosen output format, the data is enriched with labels, translations, interpretations, and hyperlinks.

The output format can be changed by adding an extension to a path:

• /phytosanitary/products
• /phytosanitary/products.json
• /phytosanitary/products.csv