Remède

Documentation

Bienvenue sur la page de documentation de Remède. Naviguez à travers les contenus si-dessous

Table des matières

Dévelopment

Structure

Installation de l’environnement de développement

Dans le dossier app

Application mobile

Dans le dossier app

Application Web

Dans le dossier app

Ce projet utilise ionic.

API

À la racine du projet

Documentation sur localhost:8000/docs.

Pour faire fonctionner le service qui permet d’ouvrir des issues, veuillez créer un fichier .github.json, qui contient:

{
  "token": "ghp_XXXXXXXX",
  "repo": "camarm-dev/remede",
  "labels": ["word"],
  "assignees": ["camarm-dev"]
}

Veuillez générer la base sqlite pour fournir la dernière version de celle-ci !

Données

Cette section est à propos des données utilisées et fournies par Remède.

Données Remède

Remède créé sa propre base de mots, synonymes, antonymes français à partir de services tiers.

Dataset

Le dossier data est destiné aux ressources linguistiques utilisées par Remède

data/mots.txt: Liste de 245 973 mots séparés de virgules

data/ipa.json: Pour une clé ‘mot’, renvoi l’IPA

data/REMEDE_a.jon: Le fichier d’indexation final (par lettre) ; pour une clé ‘mot’ renvoi son document selon le schéma REMEDE

data/remede.db: Une base sql (référence)

data/remede-less.db: Une base sql (référence) MAIS

Schéma de document Remède

Schéma JSON d’un document de mot indexé par Remède

{
  "synonymes": [
    ""
  ],
  "antonymes": [
    ""
  ],
  "etymologies": [
    ""
  ],
  "exemples": [
    ""
  ],
  "definitions": [
    {
      "genre": "",
      "classe": "",
      "explications": [
        ""
      ],
      "exemples": [
        ""
      ]
    }
  ],
  "credits": {
    "name": "page Wiktionnaire",
    "url": ""
  },
  "ipa": "//",
  "conjugaisons": {
    "indicatif": {
      "present": {
        "je": "",
        "tu": ""
      }
    }
  }
}

Base sqlite

Le fichier data/remede.db, généré par le script scripts/generate_sqlite.py (à exécuter depuis la racine du project) contient une base de données contenant tous les mots Remède.

Elle s’organise ainsi

Une table wordlist existe aussi pour rendre la recherche plus performante:

Un questionnement se pose: se schéma n’étant pas propre (stocker du JSON dans une base sql), faut-il retranscrire complètement le schéma de document Remède en plusieurs tables dnas une base ?

Fiches de français

Des fiches de français sont écrites et référencées dans le dossier data/fiches.

Elles sont écrites en markdown et utilisent le front-matter pour fonctionner.

Exemple de fiche:

---
nom: Exemple de fiche
description: Ceci est la première fiche
credits:
  attribution: Remède
  url: https://github.com/camarm-dev/remede
  text: "
Author(s): [camarm](https://github.com/camarm-dev)
Source: [Remède](https://github.com/camarm-dev/remede)
File historic and contributions: [On Github](https://github.com/camarm-dev/remede/commits/main/data/fiches/Exemple.md)
"
slug: exemple
tags: 
  - grammaire
  - orthographe
---

# Exemple

Ceci est un exemple de fiche.

Les tags disponibles sont: grammaire, orthographe, conjugaison, lexique, style, typographie

Pour créditer et permettre l’attribution de ces fiches, veuillez remplir correctement les champs credits.

Remplissez bien cette fiche, car elle permet la traçabilité et le respect de la propriété privée et intellectuelle concernant Rèmede et la provenance de ses données.