From c634db70f47139bc6fdc343094b4f25ffd4cf4a0 Mon Sep 17 00:00:00 2001 From: Nikolas Hagelstein Date: Thu, 27 Jul 2023 00:11:09 +0200 Subject: [PATCH 1/3] [FEAUTRE] Bring docker-compose.yml --- docker-compose.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docker-compose.yml diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 00000000..166df14a --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,10 @@ +services: + dev: + image: "node:16" + user: "node" + working_dir: /home/node/app + volumes: + - ./:/home/node/app + ports: + - "8080:8080" + command: sh -c "yarn install && yarn build && yarn dev" From 8b0855d8842e0b77c969e27f0799840ea4618424 Mon Sep 17 00:00:00 2001 From: Nikolas Hagelstein Date: Fri, 28 Jul 2023 21:33:23 +0200 Subject: [PATCH 2/3] [FEATURE] Add contribution instructions to readme.md --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cabd24a0..65a4d35d 100644 --- a/README.md +++ b/README.md @@ -17,4 +17,22 @@ You can use Frontmatter to change layout and other settings per page: [https://v Inside the `docs` folder, you'll find several files and folders. The file `docs/blog/helloworld.md` will be rendered to `/blog/helloworld`, the `docs/blog/readme.md` will be rendered to `/blog/` -Images and other assets can be placed into the public dir. `docs/.vuepress/public/images/example.png` and be accessed in the browser via `/images/example.png`. \ No newline at end of file +Images and other assets can be placed into the public dir. `docs/.vuepress/public/images/example.png` and be accessed in the browser via `/images/example.png`. + +## Contribution +Piece of cake: +- File an issue +- File a corresponding pull request +- "I don't know what a pull request is!" : Just file an issue, we ll take good care of you. :) + +### Setting up a Development Environment to contribute + +#### Methode #1 +tl;dr: +- clone the repository +- run "yarn install" +- run "yarn dev" + +#### Methode #2 +You got a docker environment running anyway? Lovely: +- run docker compose up From 6de4daf2b53a9e6a37eb55a3d48fcf3a6d683bc9 Mon Sep 17 00:00:00 2001 From: Nikolas Hagelstein Date: Fri, 28 Jul 2023 21:34:36 +0200 Subject: [PATCH 3/3] [TASK] Fix typos in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 65a4d35d..917c0d39 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Images and other assets can be placed into the public dir. `docs/.vuepress/publi Piece of cake: - File an issue - File a corresponding pull request -- "I don't know what a pull request is!" : Just file an issue, we ll take good care of you. :) +- "I don't know what a pull request is!": Just file an issue, we will take good care of you. :) ### Setting up a Development Environment to contribute