Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -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

# //////////////////////////////////////////////////////////////////////////////////////////////////////////////////// #
18 changes: 18 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -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"
]
}
}
}
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Binary file modified bun.lockb
Binary file not shown.