LogoLogo
  • 👋Welcome
  • For the users
    • 📱Download
      • 🔄Update application
    • 📖Offline dictionaries
    • 🌐Dictionaries servers
    • ⁉️Support
  • For the developers
    • 🖥️Getting started
    • 🛠️Develop on Remède
      • 🔌Setup
      • 📁Structure
      • 🧸Development
      • ⚙️API
      • ✨Features
        • ✈️Offline
        • 📒Sheets
        • 🧰DICT Client
      • Android development
    • 📪API
  • Database
    • 🗃️Database
      • 📋Database schema
      • 🗒️Document schema
      • 📦Dataset
      • 🎶Rimes
      • 📍Internationalization
        • 🇬🇧English database
    • 🚧Build Dictionary
      • The building lifecycle
      • Generate my own database
      • About
    • 📌Remède for your project
    • 📎Available formats
      • DICT
      • XDXF
      • CSV
    • ©️Credits
  • Project
    • 📜Story
    • 🙏Contributing
      • 🌐Translation
    • 👣Lifecycles and infrastructure
    • ⏭️Remède Next
Powered by GitBook
On this page
Edit on GitHub
  1. For the developers
  2. 🛠️Develop on Remède

🧸Development

Modify the source code in Vue to add functionalities !

PreviousStructureNextAPI

Last updated 6 months ago

Was this helpful?

Find us

  • Website
  • Github
  • Support

© 2025 The Remède Project and its contributors.

CtrlK
  • Structure
  • Scripts
  • How to develop

Was this helpful?

The main code of Remède is in the app folder. The following documentation concerns this folder, so you should move to it before continuing.

This project is developed using Ionic. It acts like a Vue website (that's why we provide a web version of the application).

Structure

  • public/: Public resources, served under /

  • src/: The Vue project

    • assets/: Assets

    • components/: Vue components

    • views/: Application pages

    • functions/: Native functionalities / dictionary or API calls...

    • router/: Router files

    • theme/: CSS styles

    • App.vue: main Vue file

    • main.ts: main typescript file

  • ionic.config.json: Ionic configuration

  • capacitor.config.json: Capacitor configuration

  • package.json

Not all the files are listed, you can find more configurations files in these folders...

Scripts

  • Development start

npm run dev 
  • Build project

npm run build 
  • Lint project

npm run lint 
  • Lint project and fix problems

npm run lint:fix 

How to develop

You can navigate through the folders and files to understand more how it is working.

  • Also check the Ionic Vue and Ionic Ui Components documentation

  • Contact us at [email protected] for more information