Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tsirysndr/base-workspace
A reproducible dev workspace, built with docker, nix, pkgx, homebrew, vscode & terraform 🧑💻✨
https://github.com/tsirysndr/base-workspace
devbox development-environment devenv docker environment-as-code flox homebrew nix pkgx terraform vscode
Last synced: 3 months ago
JSON representation
A reproducible dev workspace, built with docker, nix, pkgx, homebrew, vscode & terraform 🧑💻✨
- Host: GitHub
- URL: https://github.com/tsirysndr/base-workspace
- Owner: tsirysndr
- License: mit
- Created: 2024-01-31T15:57:23.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-19T21:26:24.000Z (3 months ago)
- Last Synced: 2024-08-21T00:25:42.720Z (3 months ago)
- Topics: devbox, development-environment, devenv, docker, environment-as-code, flox, homebrew, nix, pkgx, terraform, vscode
- Language: Dockerfile
- Homepage:
- Size: 48.8 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Base Workspace 🧑💻
[](https://github.com/tsirysndr/base-workspace/actions/workflows/ci.yml)
This is my base workspace for all my projects. It contains a portable [docker](https://docker.com) environment with [vscode tunnels](https://code.visualstudio.com/docs/remote/tunnels) already configured, provisioned using [terraform](https://terraform.io).
## 🚀 Quickstart
Create a new workspace using the [pocketenv](https://github.com/pocketenv-io/pocketenv) command line tool:
```sh
pocketenv init -t tsirysndr/base-workspace
pocketenv up
```
Or using [terraform](https://terraform.io):
```sh
git clone https://github.com/tsirysndr/base-workspace.git
cd base-workspace
terraform init
terraform apply
```
A new Docker container will be created with the name `base-workspace` with [pkgx](https://pkgx.sh), [oh-my-posh](https://ohmyposh.dev/), [atuin](https://atuin.sh/) and vscode server installed.
To connect to the environment, run:
```bash
docker logs base-workspace
```
and follow the vscode tunnel instructions.
You can also enter to the environment using:
```bash
docker exec -it base-workspace bash
```
## ✨ Bonus
[oh-my-posh](https://ohmyposh.dev/) and [atuin](https://atuin.sh/) are already configured in the environment.
## 🐚 Environments
| Name | Description |
|--------|------------------------------------------------------|
| devbox | [devbox](https://github.com/jetpack-io/devbox) environment with vscode tunnels configured. |
| devenv | [devenv](https://devenv.sh/) environment with vscode tunnels configured. |
| flox | [flox](https://flox.dev/) environment with vscode tunnels configured. |
| hombrew | [homebrew](https://brew.sh/) environment with vscode tunnels configured. |
| nix | [nix](https://nixos.org/) environment with vscode tunnels configured. |
| pkgx | [pkgx](https://pkgx.sh/) environment with vscode tunnels configured. |
| default | base environment with vscode tunnels configured. |
## ⚙️ Inputs
| Name | Description | Type | Default |
|----------------|-----------------------|----------------|------------------|
| context | Docker build context to use | `string` | `null` |
| hostname | Hostname to use | `string` | `null` |
| image | Docker image to use, required if context is not set | `string` | `ghcr.io/pocketenv-io/pkgx:main` |
| packages | Packages to install | `list(string)` | `[]` |
| user | User to create | `string` | `coder` |
| volumes | Volumes to mount | `map(string)` | `{ base-workspace = "/home/coder" }` |
| workspace_name | Name of the workspace | `string` | `base-workspace` |
## 📦 Outputs
| Name | Description | Type |
|----------------|-----------------------|----------------|
| container_id | Docker container id | `string` |
## 📚 Examples
devbox.tfvars
```hcl
workspace_name = "devbox-workspace"
user = "coder"
context = "./devbox"
volumes = {
devbox-workspace = "/home/coder"
devbox-nix = "/nix"
}
```
devenv.tfvars
```hcl
workspace_name = "devenv-workspace"
user = "coder"
context = "./devenv"
volumes = {
devenv-workspace = "/home/coder"
devenv-nix = "/nix"
}
```
flox.tfvars
```hcl
workspace_name = "flox-workspace"
user = "coder"
context = "./flox"
volumes = {
flox-workspace = "/home/coder"
flox-nix = "/nix"
}
```
homebrew.tfvars
```hcl
workspace_name = "brew-workspace"
packages = [
"jq",
"gh"
]
user = "coder"
context = "./homebrew"
volumes = {
brew-workspace = "/home/coder"
linuxbrew = "/home/linuxbrew/.linuxbrew"
}
```
pkgx.tfvars
```hcl
workspace_name = "pkgx-workspace"
packages = [
"jq",
"gh"
]
user = "coder"
context = "./pkgx"
volumes = {
pkgx-workspace = "/home/coder"
}
```
## 📝 License
This project is licensed under the [MIT License](LICENSE).