Skip to content

Commit

Permalink
Merge pull request #8777 from ministryofjustice/feat/update-devcontai…
Browse files Browse the repository at this point in the history
…ner-readme

Signed-off-by: Jacob Woffenden <[email protected]>
  • Loading branch information
jacobwoffenden authored Nov 25, 2024
2 parents 9b5b07f + 7fd2eaa commit 7c1c05e
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions .devcontainer/README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,37 @@
# Dev Container

> [!NOTE]
> This is a community supported feature
To assist in the development of `modernisation-platform-environments`, the community have built a [dev container](https://containers.dev/) with the required tooling
To assist with working on this repository, the community has configured a [dev container](https://containers.dev/) with the required tooling.

## Prerequisites
You can run this locally, or with [GitHub Codespaces](https://docs.github.com/en/codespaces/overview).

- GitHub Codespaces
## Locally

or
> [!WARNING]
> This has only been tested on macOS
### Prerequisites

- Docker

- Visual Studio Code

- Dev Containers Extention

## Running

### GitHub Codespaces

Launch from GitHub
To launch locally, ensure the prerequisites are met, and then click the button below

### Locally
[![Open in Dev Container](https://raw.githubusercontent.com/ministryofjustice/.devcontainer/refs/heads/main/contrib/badge.svg)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/ministryofjustice/modernisation-platform-environments)

1. Ensure prerequisites are met
## GitHub Codespaces

1. Clone repository
> [!IMPORTANT]
> GitHub Codespaces are not currently paid for by the Ministry of Justice and are subject to the quotas [here](https://docs.github.com/en/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#monthly-included-storage-and-core-hours-for-personal-accounts)
1. Open repository in Visual Studio Code
To launch a GitHub Codespace, click the button below

1. Reopen in container
[![Open in Codespace](https://github.com/codespaces/badge.svg)](https://codespaces.new/ministryofjustice/modernisation-platform-environments)

## Tools

Expand Down

0 comments on commit 7c1c05e

Please sign in to comment.