status-im
/
spiff-arena
mirror of https://github.com/status-im/spiff-arena.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
Violet 2023-09-02 16:18:47 -07:00 committed by GitHub
parent 3f5c0b3df8
commit 3efa911438
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -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.