Setting up development environment
Follow these steps before developing on Remède.
Setting up Ionic framework
Remède uses Ionic. You will install npm dependencies and requirements to start developing with Ionic.
- Make sure you have node 18 installed.
- Move to the
app/
folder - Install dependencies
npm install
- Install Ionic
npm install -g @ionic/cli
Setting up mobile development - Android
Ionic framework let us build Remède for native platforms with Capacitor.
Developing for Android does not need special requirements. Just install npm dependencies.
See Capacitor documentation for more information.
Make sure you have Android Studio installed.
Setting up mobile development - iOS
Ionic Framework let us build Remède for iOS.
We do not build Remède for iOs yet. Follow the official Ionic documentation.
Remède has not been tested yet on iOS ! Build and use it at your own risks…
Setting up API development
Remède has a public API written with FastAPI.
- Make sure you have Python 3 installed.
- Install dependencies
pip install fastapi uvicorn starlette python-frontmatter markdown
- Fetch database so the API can serve it
Fetch database
Remède latest database is not served by git because it is too large… We host our database on our own servers.
To fetch the latest database, you can use curl
or wget
as you prefer…
Execute these commands at project root.
- With
curl
curl -o data/remede.db https://api-remede.camarm.fr/download?variant=remede
- With
wget
wget -O data/remede.db https://api-remede.camarm.fr/download?variant=remede
Remède used to store its databases on Github LFS servers but our quota has been exceeded… The databases which are still stored in git lfs are outdated.