From a0337f08589938f055e4b07feae2782461ef7ea4 Mon Sep 17 00:00:00 2001 From: Adrien Allard Date: Thu, 6 Jun 2024 16:07:26 +0200 Subject: [PATCH] docs: add doc about how to setup devenv and setup vscode tasks for basic automation --- .vscode/tasks.json | 23 +++++++++++++++++++++++ README.md | 7 +++++++ 2 files changed, 30 insertions(+) create mode 100644 .vscode/tasks.json diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..da2850e --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,23 @@ +{ + // See https://go.microsoft.com/fwlink/?LinkId=733558 + // for the documentation about the tasks.json format + "version": "2.0.0", + "tasks": [ + { + "label": "Start dev server", + "type": "shell", + "command": "browser-sync start --server build/ --watch" + }, + { + "label": "Build", + "group": "build", + "type": "shell", + "command": "nox -R -s build" + }, + { + "label": "Extract localization messages", + "type": "shell", + "command": "nox -R -s extract_messages" + } + ] +} diff --git a/README.md b/README.md index abbc566..b3bf083 100644 --- a/README.md +++ b/README.md @@ -58,3 +58,10 @@ We use the BEM naming convention with the scheme See https://getbem.com/naming/ for insigths on the BEM naming convention. We use SASS as a CSS extension language (https://sass-lang.com/). + +### Dev env + +Install the following dependencies to be able to test the website locally: +```sh +npm install -g browser-sync +```