📁Structure

Understand how Remède is structured.

Good practise

To discover and understand the project structure, start a development server and try to modify some files and see what changes.

• server.py: Main API, made with Fastapi

• data/: Dataset and Remède databases

• app/: Ionic project

  • src/: Vuejs project

    • components : Vue components for the interface

    • data : Static data like translations (see Translation)

    • functions : Typescript file to interact with native API or manage the offline dictionary

    • views : The "views" (pages) of the application

  • tauri-src/: Tauri Project

  • android/: Android project, generated by @capacitor/android

• api-definition: API to fetch Wictionary definitions (it's a git submodule)

• scripts/: Scripts to parse, generate and make migrations on the database.

• convert : Tools and scripts used to convert Remède databases to other dictionaries formats

• docs/: The website and blog of Remède. The documentation is at labsesoftware/docs.remede.camarm.fr

• corrector/: Docker to run languagetool API

• tts/: Docker compose to run nanotts with opentts

• builds/latest: Latest builds for platforms (can be outdated...)

Of course, there are more folders...