chore: add devcontainer for local development

konstructio · Aug 7, 2024 · 4a75719 · 4a75719
1 parent 872ad15
commit 4a75719
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -0,0 +1,11 @@
+{
+    "name": "devcontainer",
+    "image": "ghcr.io/kubefirst/devcontainers/full",
+    "features": {},
+    "customizations": {
+      "vscode": {
+        "extensions": [],
+        "settings": {}
+      }
+    }
+}
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ This is the Kubefirst Frontend project that shows all the Kubefirst installed se
 
 ## Setup Instructions
 
-- Clone this repository. You will need `node` and `yarn` installed globally on your machine.
+- Clone this repository. You will need `node` and `yarn` installed globally on your machine. A [.devcontainer](https://containers.dev/) configuration is provided to allow for a full-featured development environment.
 - Create a .env file in the root of the project
 - You can copy the env values from `.env.local.example` to have a local installation experience or you can use `.env.cluster.example` to have a cluster install experience.
 - Make sure you are using **NodeJS** >= v16.15.1