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/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