From 5dfa8ef1b6d88f059cc0a00068f92fca83f9e771 Mon Sep 17 00:00:00 2001 From: Thomas Schwery Date: Sun, 13 Oct 2019 15:11:09 +0200 Subject: [PATCH] Improve the project description in the readme --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e5cb428..8358152 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,14 @@ Ce repository contient le code source des différents livres de recettes et du blog des recettes. -Le site est généré automatiquement lorsque les Merge Requests sont acceptées +Le site est généré et publié automatiquement lorsque les Merge Requests sont acceptées et les modifications intégrées sur la branche `master`. ## URLs utiles ## Usage Le blog peut être généré en local avec `nodejs`. Il suffit d'installer -les dépendances avec `npm install`, puis, une fois celles-ci installées, +les dépendances avec `npm ci`, puis, une fois celles-ci installées, lancer la génération avec `npm run build`. ## Ajouter des recettes @@ -26,3 +26,16 @@ lancer la génération avec `npm run build`. 8. `git push` pour envoyer sur le serveur 9. Suivre le lien donné pour créer une Merge Request avec les nouvelles recettes. + +### Visualiser les changements +* En local, il est possible de compiler le site avec `npm run build` puis + visualiser le site généré avec `http-server build`. +* A distance, GitLab compile et déploie sur le site sur une addresse de prévisualisation + disponible dans la MR. + +## Technologies +* Le site est généré statiquement avec [metalsmith](https://metalsmith.io/) +* Les fichiers générés sont déployés automatiquement dans un bucket Amazon S3 +* Le site web est distribué par Amazon CloudFront +* Un fichier epub avec les recettes est généré à partir des pages générées + statiquement.