Merci :) Ton aide est la bienvenue !
Le guide de contribution se trouve dans le fichier CONTRIBUTING.md
You need minimum
node@12 to be able to properly run
Don't hesitate to install multiple
node version in your dev environment using n
Install dependencies :
Run vite (we're obviously using vitejs for vite-ma-dose !) :
npm run dev or
Open your browser : http://localhost:3000/ and enjoy live reload / on-the-fly typescript compilation
You can also click on this link in order to open a Gitpod workspace with everything loaded in it.
Alternative: Running with docker
If you don't want to install node.js on your machine, you can isolate it with docker:
Start docker container (that executes
npm run dev) :
The first time
docker-compose up is run, it will build the
base docker image with
npm install inside
node:14 docker image.
package*.json have changed, you need to rebuild the base image:
docker-compose down --volumes docker-compose build
.. then start again with
To inspect what happens inside :
docker-compose exec frontend bash
Package for production with
vite build :
dist directory will contain minified assets for production
For debug purposes, if you want to generate sourcemaps for production build, you can configure
vite.config.ts file by changing the
build.sourcemap config property to
See vitemadose-android and vitemadose-ios.
mainis automatically deployed on https://vitemadose.covidtracker.fr/
=> Push on this branch only when you're ready.
devis the development branch, start any new feature/fix from it.
We generally try to create dedicated feature branches with issue number in it, except when the commit is really small
We're using :
- Typescript as the main language => typescript for js programmers
- lit-element as the web-component library => https://lit.dev/
- pagejs as our routing library => documentation
- Bootstrap as the CSS library => https://getbootstrap.com/docs/5.0/getting-started/introduction/ (icons)
- SASS as CSS transpiler => documentation
- ViteJS for the development/production build toolchain => guide