commun/recettes
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve the project description in the readme

Browse source
This commit is contained in:
Thomas Schwery 2019-10-13 15:11:09 +02:00
parent b2b6bda57c
commit 5dfa8ef1b6
1 changed files with 15 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -3,14 +3,14 @@
Ce repository contient le code source des différents livres de recettes Ce repository contient le code source des différents livres de recettes
et du blog des 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`. et les modifications intégrées sur la branche `master`.
## URLs utiles ## URLs utiles
## Usage ## Usage
Le blog peut être généré en local avec `nodejs`. Il suffit d'installer 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`. lancer la génération avec `npm run build`.
## Ajouter des recettes ## Ajouter des recettes
@ -26,3 +26,16 @@ lancer la génération avec `npm run build`.
8. `git push` pour envoyer sur le serveur 8. `git push` pour envoyer sur le serveur
9. Suivre le lien donné pour créer une Merge Request avec les nouvelles 9. Suivre le lien donné pour créer une Merge Request avec les nouvelles
recettes. 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.