From 36713397c9c54abb63c28409afe288346bed5815 Mon Sep 17 00:00:00 2001 From: Kyle Lawlor-Bagcal Date: Wed, 18 Oct 2023 20:43:25 -0400 Subject: [PATCH] docs: readme section about local dev with docker --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index cff4bdc..4ad8eda 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,16 @@ See [migrations/README.md](migrations/README.md). This application is deployed in a pipeline in heroku. There is a staging environment in addition to the production environment. +## Local development with docker + +You can make use of docker to bring up the various components required for development. +See the `docker-compose.yml` for information on what the components are. +The following command will bring up the system: + +``` +docker-compose up +``` + ## E2E Testing Currently we have a set of e2e tests written using the Regen CLI and shell scripts.