From 9bd3f6c5bce204dfe136e0fd810d6c56c4f17fd8 Mon Sep 17 00:00:00 2001 From: Alex Parsons Date: Thu, 4 Jan 2024 15:33:32 +0000 Subject: [PATCH] Add codespaces badge to readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 93588cfbfa..0ceaea7482 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# TheyWorkForYou + Hello everyone, This is the source code that powers the TheyWorkForYou.com website. It's @@ -49,8 +51,12 @@ To use xdebug in VS Code while using WSL, you'll need to set an environmental va # Developing with codespaces +[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/mysociety/theyworkforyou?devcontainer_path=.devcontainer%2Fauto-quick-setup%2Fdevcontainer.json) + Start a new codespace on Github by selecting the Code dropdown (top right), and starting a new codespace (or use the [GitHub CLI](https://github.com/cli/cli)). +You can also use the badge above to use a prebuild with a basic amount of data. + This will setup the Docker container and environment. Once finished, the link to the site should be avaliable in the ports tab of the terminal panel. To populate with a minimal amount of data, run `scripts/quick-populate` (about 1 hour).