From ac07fd237fa7e42ac2db36d72ea6a1ae683313ae Mon Sep 17 00:00:00 2001 From: Ryan Hayes Date: Sun, 7 May 2023 17:09:44 -0400 Subject: [PATCH 1/3] Adds a docker devcontainer configuration. --- .devcontainer/devcontainer.json | 28 ++++++++++++++++++++++++++++ package-lock.json | 2 +- 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 .devcontainer/devcontainer.json diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..42514b6 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,28 @@ +// For format details, see https://aka.ms/devcontainer.json. For config options, see the +// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node +{ + "name": "Node.js & TypeScript", + // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile + "image": "mcr.microsoft.com/devcontainers/typescript-node:0-20", + "features": { + "ghcr.io/devcontainers/features/node:1": { + "nodeGypDependencies": true, + "version": "lts" + } + } + + // Features to add to the dev container. More info: https://containers.dev/features. + // "features": {}, + + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "yarn install", + + // Configure tool-specific properties. + // "customizations": {}, + + // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. + // "remoteUser": "root" +} diff --git a/package-lock.json b/package-lock.json index 1e881dc..edb7838 100644 --- a/package-lock.json +++ b/package-lock.json @@ -18,7 +18,7 @@ "eslint-plugin-import": "^2.26.0", "eslint-plugin-n": "^15.3.0", "eslint-plugin-promise": "^6.0.1", - "netlify-cli": "^2.12.0", + "netlify-cli": "^2.71.0", "sass": "^1.55.0", "svelte": "^3.44.0", "svelte-check": "^2.7.1", From 01d16b18b183c6df828acbff26f2db1e70f65ed5 Mon Sep 17 00:00:00 2001 From: Ryan Hayes Date: Sun, 7 May 2023 17:28:48 -0400 Subject: [PATCH 2/3] Updates readme. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index bfc5933..139e540 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,18 @@ Feel free to add suggestions to Issues and submit pull requests for Issues that ## Developing +### Prerequisites + +* (The latest stable version of Node)[https://nodejs.org/en/download] + +### Using a Dev Container + +If you don't want to install Node or other tools locally, or you have antivirus causing slowness on build, use the configured VS Dev Container. + +For more info on dev containers, visit (VS Code Dev Containers)[https://code.visualstudio.com/docs/devcontainers/containers] + +### Running in dev mode + Once you've cloned this project, you'll need to run `npm install` to grab all of the dependencies necessary. ```bash From e9d19722901dfe61fea682528c874b29a47fb50a Mon Sep 17 00:00:00 2001 From: Ryan Hayes Date: Sun, 7 May 2023 17:30:26 -0400 Subject: [PATCH 3/3] Revert version bump since unrelated. --- package-lock.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package-lock.json b/package-lock.json index edb7838..1e881dc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -18,7 +18,7 @@ "eslint-plugin-import": "^2.26.0", "eslint-plugin-n": "^15.3.0", "eslint-plugin-promise": "^6.0.1", - "netlify-cli": "^2.71.0", + "netlify-cli": "^2.12.0", "sass": "^1.55.0", "svelte": "^3.44.0", "svelte-check": "^2.7.1",