Skip to content

Commit 0af3f4d

Browse files
squashme! update docs to emphasize codespace
1 parent 3358d5c commit 0af3f4d

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,19 +134,22 @@ You might also want to try VSCode with [this WSL extension](https://marketplace.
134134
```
135135
</details>
136136

137-
## Codespaces and Dev Container - EXPERIMENTAL 🛠️
137+
## One-click in-the-cloud env via Codespaces and Dev Container - EXPERIMENTAL 🛠️
138138

139139
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/rubyforgood/human-essentials/tree/fix-devcontainers?quickstart=1)
140140

141-
[![Clone and open in VSCode Dev Container](https://img.shields.io/static/v1?label=Dev%20Containers&message=Clone%20and%20Open%20in%20VSCode&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/rubyforgood/human-essentials)
142-
143141
1. Create the container:
144142
- To run the container on a Github VM, follow the Codespace link above. You can connect to the Codespace using VSCode or the VSCode web editor.
145143
- Or follow instructions to [create a new Codespace.](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository)
146144
- To clone this repo and run the container locally, follow instructions to [install VSCode and Docker](https://code.visualstudio.com/docs/devcontainers/containers). Click the Dev Container link above. Don't forget to add a git remote pointing to your fork once the container is setup and you want to push changes.
147145
2. Wait for the container to start. This will take a few (10-15) minutes since Ruby needs to be installed, the database needs to be created, and the `bin/setup` script needs to run
148-
3. Run `bin/start`. On the Ports tab, visit the forwarded port 3000 URL marked as Application to see the human essentials page.
149-
4. Login as a sample user with the default [credentials](#credentials).
146+
3. Run `bin/start`.
147+
4. On the Ports tab, visit the forwarded port 3000 URL marked as Application to see the human essentials page.
148+
5. Login as a sample user with the default [credentials](#credentials).
149+
150+
### Further experimental option—local dev container
151+
152+
[![Clone and open in VSCode Dev Container](https://img.shields.io/static/v1?label=Dev%20Containers&message=Clone%20and%20Open%20in%20VSCode&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/rubyforgood/human-essentials)
150153

151154
## Troubleshooting 👷🏼‍♀️
152155

0 commit comments

Comments
 (0)