From 98a4aa4b0ce7606656a5b3e4a833dc0e029e5636 Mon Sep 17 00:00:00 2001 From: Violet <7075901+violet4@users.noreply.github.com> Date: Sat, 2 Sep 2023 16:18:47 -0700 Subject: [PATCH] Update README.md with information about docker (#459) * Update README.md with information about docker point to spiffworkflow.org docker guide and mention the differences between docker-compose.yml and editor.docker-compose.yml * fixes to README.md about description of `editor.docker-compose.yml` following feedback from @jbirddog --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index b1994bfc..a456710b 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,12 @@ Get the app running so you can access the frontend at http://localhost:7001 in y ./bin/run_cypress_tests_locally +## Docker + +For full instructions, see [Running SpiffWorkflow Locally with Docker](https://www.spiffworkflow.org/posts/articles/get_started_docker/). + +The `docker-compose.yml` file is for running a full-fledged instance of spiff-arena while `editor.docker-compose.yml` provides BPMN graphical editor capability to libraries and projects that depend on SpiffWorkflow but have no built-in BPMN edit capabilities. + ## Contributing This is a monorepo based on git subtrees that pulls together various spiffworkflow-related projects.