diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 0000000..21ed7d8 --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,23 @@ +# //////////////////////////////////////////////////////////////////////////////////////////////////////////////////// # + +ARG VARIANT=latest + +# //////////////////////////////////////////////////////////////////////////////////////////////////////////////////// # + +FROM oven/bun:${VARIANT} + +# //////////////////////////////////////////////////////////////////////////////////////////////////////////////////// # + +RUN apt-get update \ + && apt-get -y install --no-install-recommends \ + git \ + && apt-get auto-remove -y \ + && apt-get clean -y \ + && chsh -s $(which bash) bun \ + && echo 'export PS1="\e[01;32m\u\e[m:\e[01;34m\w\e[m\$ "' >> /home/bun/.bashrc + +# //////////////////////////////////////////////////////////////////////////////////////////////////////////////////// # + +USER bun + +# //////////////////////////////////////////////////////////////////////////////////////////////////////////////////// # \ No newline at end of file diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..3cd1795 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,18 @@ +{ + "name": "@vueclid/devcontainer", + "build": { + "dockerfile": "Dockerfile", + // Update 'VARIANT' to pick a Bun version. + "args": { + "VARIANT": "latest" + } + }, + "customizations": { + "vscode": { + "extensions": [ + "ms-vscode.vscode-typescript", + "Vue.volar" + ] + } + } +} \ No newline at end of file diff --git a/README.md b/README.md index d765ebe..206afcd 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,36 @@ Pixel-perfect math diagrams for Vue.js. npm install @ksassnowski/vueclid ``` +## Contributing + +### Prerequisites + +- **[Visual Studio Code](https://code.visualstudio.com/)** +- **[Docker](https://www.docker.com/get-started)** +- **[Git](https://git-scm.com/downloads)** + +### Development + +### 1. Clone the Repository + +```bash +git clone https://github.com/ksassnowski/vueclid +cd vueclid +``` + +To keep the project dependency management simple, the use of development containers is recommended. To get started, simply + +### 2. Reopen in Dev Container + +1. Click the green `><` icon in the bottom-left corner of VSCode. +2. Select `Reopen in Container`. +3. Wait for the Dev Container to build and initialize. This may take a few minutes on the first run. + +### 3. Working Inside the Dev Container + +- **Access the Terminal**: Use `Terminal` > `New Terminal` to open a terminal within the container. +- **Edit Code**: Develop your code as usual. All changes are made within the isolated environment provided by the Dev Container. + ## Credits - [Kai Sassnowski](https://github.com/ksassnowski) diff --git a/bun.lockb b/bun.lockb index c405dbe..7e70bce 100755 Binary files a/bun.lockb and b/bun.lockb differ