Skip to content

Commit

Permalink
Add devcontainer setup
Browse files Browse the repository at this point in the history
It will make contributions easier by allowing people
to get it working locally with one click or to bring
it up in github codespace.
  • Loading branch information
radanskoric committed May 24, 2024
1 parent c397c31 commit 68213cb
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
FROM node:latest

WORKDIR /site

CMD ["npm", "run serve"]
8 changes: 8 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "Npm setup for building the turbo site",
"build": {
"dockerfile": "Dockerfile"
},
"postCreateCommand": "npm install",
"postStartCommand": "npm run serve"
}
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,18 @@ This repository backs the website living at https://turbo.hotwired.dev.

To work on it locally:

## Option A: Directly on your machine

1. `npm install`
2. `npm run serve`
3. (If you need it: `npm install markdown-it` and rerun step #2).

## Option B: Using a devcontainer

There is a devcontainer configuration that, when started, will perform all of the setup and serve the website on port 8080.

For example, in VSCode, run "Reopen in Container" and wait for it to finish and access the site on http://localhost:8080/,

## Copyright

The logo, design, and other aesthetic parts of this website is copyright 37signals, all rights reserved. Feel free to be inspired by the structure, but do not copy the specific design, anymore than you'd copy basecamp.com or hey.com.

0 comments on commit 68213cb

Please sign in to comment.