From 0061a858880f87b9951f864f017c2a200440287e Mon Sep 17 00:00:00 2001 From: sam32123 Date: Wed, 20 Nov 2024 19:10:37 +0000 Subject: [PATCH] updated README to comply with devcontainer --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7f188fe..9214aeb 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ Study Association Sticky's website is a static website built in React with Gatsb ## Installation -1. Install Node Version Manager [nvm](https://github.com/creationix/nvm). -2. Install the required version of Node.JS (v13.11.0) by running `nvm install --latest-npm` in the project directory. -3. Install dependencies with `npm install`. +1. Make sure you have the [Docker engine](https://docs.docker.com/engine/), as well as [Visual studio code](https://code.visualstudio.com/) with the [Devcontainers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extention installed. +2. open the project in a dev containter. The default shortcut for this (in VS Code) is: CTRL+Shift+P, and then typing `open folder` in container. You may have to select the project folder. If this takes longer than expected, please read the warning below. +3. Open a terminal in the dev container. You can do this by pressing `Terminal` (in the hotbar), then `New terminal`. Alternatively, you can use the default keybinds: CTRL+Shift+`. 4. Create .env file: `cp sample.env .env`. 5. Fill .env with the required api keys from [contentful](https://app.contentful.com/). Ask someone in the CommIT for the right keys to use.