Requirements

You need minimum node@12 to be able to properly run ViteJS

Don't hesitate to install multiple node version in your dev environment using n

Boostrap

Install dependencies : npm install

Run vite (we're obviously using vitejs for vite-ma-dose !) : npm run dev or vite (see package.json scripts)

Open your browser : http://localhost:3000/ and enjoy live reload / on-the-fly typescript compilation

Production

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 true

Mobile apps

See dedicated readme in mobile/ directory

Development workflow

• main is automatically deployed on https://vitemadose.covidtracker.fr/

  => Push on this branch only when you're ready.

• dev is 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

Stack pointers

We're using :

• Typescript as the main language => typescript for js programmers
• lit-component as the web-component library => lit-element guide and lit-html guide
• 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