Bienvenue sur la page de documentation de Remède. Naviguez à travers les contenus si-dessous
app: The ionic projectscripts: Build, migrate and generate databasedata: Dataset and related ressourcesbuilds: Executables by platformDans le dossier app
npm i
npm i -g @ionic/cli
git lfs install
Dans le dossier app
ionic cap build android
Dans le dossier app
Ce projet utilise ionic.
npm run dev
À la racine du projet
pip install fastapi uvicorn starlette python-frontmatter markdown
git lfs pull
python3 server.py
En ligne sur localhost:8000 !
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 !
Cette section est à propos des données utilisées et fournies par Remède.
Remède créé sa propre base de mots, synonymes, antonymes français à partir de services tiers.
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/IPA.txt: un fichier sur le format [mot]\t[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 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": ""
}
}
}
}
synonymes ([]string): Liste des mots synonymesantonymes ([]string): Liste des mots antonymesetymologies ([]string): Liste d’étymologiesexemples ([]string): Liste d’exemplesdefinitions ([]{}): Liste d’objets contenants une définition du mot
genre (string): Genre du mot qui est définiclasse (string): Classe grammaticale du mot définiexplications ([]string): Listes des explications possibles de cette définitionexemples ([]string): Listes des exemples d’utilisation du mot (NON IMPLÉMENTÉ)credits ({}): Objet contenant les crédits relatifs à la définition
name (string): Nom de la sourceurl (string): Url de la sourceipa (string): Prononciation du mot selon l’International Phonetic Alphabetconjugaisons ({}): Objet contenant les conjugaisons du mot si c’est un verbe
[nom du mode] ({}): Objet contenant les temps du mode
[nom du temps] ({}): Objet contenant les formes verbales du temps
[sujet] (string): Forme verbale du verbe (de mode, temps, sujet)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 dictionary
Les champs
string: le mot)string: le document Remède en format JSON)Une table wordlist existe aussi pour rendre la recherche plus performante:
word contient le motindexed contient le mot; sans accents, sans majuscules, sans tirets et sans apostropheUn 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 ?
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.
credits.url: L’url de la source (Le github Remède, ou lien du site source)credits.attributions: La personne ou le projet à citer en cas d’attributioncredits.text: Les ressources annexes qui vous ont aidés, l’historique des modifications du fichierRemplissez 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.