commit e9e0a1402a827f75db0f5c87d1d5870d89e9de6c Author: LAB-MI <72795817+betalabmi@users.noreply.github.com> Date: Sat Oct 17 09:54:48 2020 +0200 Create README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad0c546 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# Générateur de certificat de déplacement + +## Développer + +### Installer le projet + +```console +git clone https://github.com/lab-mi/attestation-couvre-feu-covid-19.git +cd attestation-couvre-feu-covid-19 +npm i +npm start +``` + +Et visiter http://localhost:1234 + +## Générer et tester le code de production + +### Tester le code de production en local + +#### Générer le code de production pour tester que le build fonctionne en entier + +```console +npm run build:dev +``` + +#### Tester le code de production en local + +```console +npx serve dist +``` + +Et visiter http://localhost:5000 + +## Crédits + +Ce projet a été réalisé à partir d'un fork du dépôt [deplacement-covid-19](https://github.com/nesk/deplacement-covid-19) lui-même réalisé à partir d'un fork du dépôt [covid-19-certificate](https://github.com/nesk/covid-19-certificate) de [Johann Pardanaud](https://github.com/nesk). + +Les projets open source suivants ont été utilisés pour le développement de ce +service : + +- [PDF-LIB](https://pdf-lib.js.org/) +- [qrcode](https://github.com/soldair/node-qrcode) +- [Bootstrap](https://getbootstrap.com/) +- [Font Awesome](https://fontawesome.com/license)