diff --git a/README.md b/README.md index 346a4f738491c03237eb3bd01edbe0362a3bd965..d48e7e29c3fb90f4fa8eed3e56e4a9f5c6c9372c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ -## Site [monnaie-libre.fr](https://monnaie-libre.fr) +# Site [monnaie-libre.fr](https://monnaie-libre.fr) Ceci est le dépôt du site. +## Sommaire + [[_TOC_]] -Si vous n'êtes pas développeur et souhaitez contribuer à la rédaction du site, passez par l'administration du site [https://monnaie-libre.fr/admin/](). -{: .alert .alert-danger} +Si vous n'êtes pas développeur et souhaitez contribuer à la rédaction du site, passez par l'[administration du site](https://monnaie-libre.fr/admin/).{: .alert .alert-danger} ### Build Setup @@ -25,39 +26,43 @@ $ yarn start For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org). -## Le back office (netlify) +# Administration : le back office + +Vous pouvez accéder à l'administration ici : https://monnaie-libre.fr/admin/ +Le back office est conçu avec [netlify cms](https://www.netlifycms.org/) qui est lui même couplé à ce dépôt. Tout changement effectué en back office créera une demande de fusion dans ce dépôt. +Vous devez avoir un compte sur ce gitlab (git.duniter.org) pour pouvoir accéder au back office. -Ici pour l'instant : https://monnaie-libre-fr.duniter.io/admin +## Lancer le back office (netlify) -### Lancer le back office (netlify) +Si vous avez cloner le dépôt sur votre ordinateur, vous pouvez lancer le back office en local : yarn admin -Puis aller sur http://localhost:3000/admin +Puis aller sur http://localhost:3000/admin/ -### Fichier de configuration +## Configuration de netlify - - `static/admin/config.yml` Paramètres de netlify - - `static/admin/index.html` HTML de la page d'administration de netlify +- `static/admin/config.yml` Paramètres de netlify +- `static/admin/index.html` HTML de la page d'administration de netlify -## Design +# Design -### Storybook +## Storybook Idée abandonnée. J'ai installé, configuré et testé. Mais c'est compliqué, et finalement pas super intégré pour vue.js... -### Afficher toutes les `class` de tailwindcss +## Afficher toutes les `class` de tailwindcss http://localhost:3000/_tailwind/ Sur cette page, vous pouvez copier une class css en cliquant sur le nom, ou maj+click pour copier plusieurs class. -### Icônes +## Icônes https://fontawesome.com/icons?m=free https://www.figma.com/file/Gof5rulCCUMvwk3WDKlgVY/H%C3%A9ro-monnaie-libre.fr?node-id=30%3A0 -## Docs +# Docs - @nuxt/content https://content.nuxtjs.org/fr et https://nuxtjs.org/docs/2.x/directory-structure/content/ - @nuxt/svg https://github.com/nuxt-community/svg-module @@ -80,12 +85,12 @@ https://mertjf.github.io/tailblocks/ http://blocks.wickedtemplates.com/ https://www.creative-tim.com/learning-lab/tailwind-starter-kit/documentation/download -### Divers +## Divers https://maizzle.com https://vuetensils.stegosource.com/introduction.html -## Generate fake data +# Generate fake data Modifier le fichier `test/generate-md-files.js` puis : @@ -107,9 +112,9 @@ Then start our Nginx Docker container with this command: dk run --rm -d -v $(pwd)/dist:/usr/share/nginx/html -p 80:80 nginx:alpine -Go to [](http://localhost/) ! +Go to http://localhost/ ! -You can change the port. In the command above, replace `80:80` by `4000:80` and go to [](http://localhost:4000/) +You can change the port. In the command above, replace `80:80` by `4000:80` and go to http://localhost:4000/ # CI Gitlab