Skip to content

Commit

Permalink
chore: introduce dev containers
Browse files Browse the repository at this point in the history
  • Loading branch information
raqystyle committed Feb 6, 2023
1 parent 50808c2 commit 493feb7
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 3 deletions.
31 changes: 31 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
// 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-18",
"features": {
"ghcr.io/devcontainers-contrib/features/pnpm:2": {}
},

// 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": {
"vscode": {
"extensions": [
"dbaeumer.vscode-eslint"
]
}
}

// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
node_modules
.pnp
.pnp.js
.pnpm-store/

# testing
coverage
Expand Down
5 changes: 3 additions & 2 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// See http://go.microsoft.com/fwlink/?LinkId=827846
// for the documentation about the extensions.json format
"recommendations": [
"dbaeumer.vscode-eslint"
]
"dbaeumer.vscode-eslint",
"ms-vscode-remote.remote-containers"
]
}
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,22 @@ Your contributions will eventually help save countless hours for people struggli
1. Node.js version installed, [latest LTS is recommended](https://nodejs.org/en/about/releases/)
2. Install pnpm

### Using [devcontainer](https://code.visualstudio.com/docs/devcontainers/create-dev-container)

Devcontainers is an easy way to avoid "works on my machine" situations. Essentially, the development happens in a Docker container.

1. Make sure you've got Docker installed on your machine
2. Do install the recommended by VSCode extensions
3. Click "Reopen in Container" button in a popup

## How to start developing?

Clone the repo and install the needed dependencies for all the packages by following these steps:

```sh
git clone https://github.com/mattpocock/ts-error-translator.git
cd ts-error-translator
pnpm
pnpm install
pnpm dev # This will run the next app
```

Expand Down

0 comments on commit 493feb7

Please sign in to comment.