sartography
/
spiff-arena
mirror of https://github.com/sartography/spiff-arena.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
SpiffWorkflow is a software development platform for building, running, and monitoring executable diagrams https://www.spiffworkflow.org/
3,388 Commits 45 Branches 61 Tags 129 MiB
Python 61.9%
TypeScript 32.3%
Shell 2.9%
JavaScript 1.1%
CSS 1%
Other 0.8%
Go to file
Kevin Burnett 687b90bc94
update dmn modeling component versions (#857) 
* update dmn-js and dmn-js-shared

* update dmn-js-properties-panel

* fixed broken cypress test w/ burnettk

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>
Co-authored-by: jasquat <jasquat@users.noreply.github.com>
 		2024-01-09 14:00:53 -05:00
.github upgrade pip for safety 2023-12-08 13:32:49 -05:00
bin added script to list the docker tags from ghcr w/ burnettk 2023-11-08 15:24:31 -05:00
connector-proxy-demo check that connector-proxy-demo can run when releasing new tags w/ burnettk 2023-12-06 11:21:32 -05:00
docs Feature/side by side layout (#858) 2024-01-05 15:49:40 -05:00
spiffworkflow-backend added comment in migration to explain why it was being done w/ burnettk 2024-01-04 14:38:57 -05:00
spiffworkflow-frontend update dmn modeling component versions (#857) 2024-01-09 14:00:53 -05:00
.coderabbit.yaml document language server for coderabbit 2023-12-20 12:59:27 -05:00
.darglint added some base stuff to get pyl working 2022-10-27 09:15:56 -04:00
.flake8 pyl and turn back on autoreload for homepage w/ burnettk 2023-04-13 16:56:49 -04:00
.gitignore use a slightly safer time in migration script. w/ jlantz 2023-08-29 12:22:43 -04:00
.pre-commit-config.yaml Feature/background proc with celery (#788) 2023-12-05 11:41:59 -05:00
.readthedocs.yaml use requirements.txt for readthedocs build. 2023-05-18 11:26:47 -04:00
.tool-versions Move to Python 3.11 (#27) 2022-11-09 13:45:16 -05:00
CONTRIBUTING.rst Feature/pin spiff in ci (#428) 2023-08-03 11:49:30 -04:00
Jenkinsfile ci: sent Discord notifications for all builds 2023-06-01 20:16:17 +02:00
LICENSE Initial commit 2022-10-12 10:17:40 -04:00
README.md minor change to kick ci 2023-12-26 18:10:04 -05:00
docker-compose.yml feature/fix-run-scheduler-config (#456) 2023-08-31 16:09:26 -04:00
editor.docker-compose.yml feature/fix-run-scheduler-config (#456) 2023-08-31 16:09:26 -04:00
poetry.lock Feature/background proc with celery (#788) 2023-12-05 11:41:59 -05:00
pyproject.toml let ruff sort imports and ditch duplicative pre-commit linters 2023-05-26 20:01:08 -04:00

README.md

spiff-arena

SpiffArena is a low(ish)-code software development platform for building, running, and monitoring executable diagrams. It is intended to support Citizen Developers and to enhance their ability to contribute to the software development process. Using tools that look a lot like flow-charts and spreadsheets, it is possible to capture complex rules in a way that everyone in your organization can see, understand, and directly execute.

Please visit the SpiffWorkflow website for a Getting Started Guide to see how to use SpiffArena and try it out. There are also additional articles, videos, and tutorials about SpiffArena and its components, including SpiffWorkflow, Service Connectors, and BPMN.js extensions.

Backend Setup

First install python, poetry, and mysql. Then:

cd spiffworkflow-backend
poetry install
./bin/recreate_db clean
./bin/run_server_locally

Keycloak Setup

You will want an openid server of some sort. There is one built in to the app that is used in the docker compose setup for simplicity, but non-compose defaults use a separate keycloak container by default. You can start it like this:

./keycloak/bin/start_keycloak

Frontend Setup

First install nodejs, ideally the version in .tool-versions (but likely other versions will work). Then:

cd spiffworkflow-frontend
npm install
npm start

Run tests

./bin/run_pyl

Run cypress automated browser tests

Get the app running so you can access the frontend at http://localhost:7001 in your browser by following the frontend and backend setup steps above, and then:

./bin/run_cypress_tests_locally

Docker

For full instructions, see Running SpiffWorkflow Locally with 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

To start understanding the system, you might:

  1. Explore the demo site via the Getting Started Guide
  2. Clone this repo, cd docs, run ./bin/build, and open your browser to http://127.0.0.1:8000 to view (and ideally edit!) the docs
  3. Check out our GitHub issues, find something you like, and ask for help on discord

Please ignore the SpiffWorkflow directory at the root of spiff-arena. We use https://github.com/sartography/SpiffWorkflow instead.

Monorepo

This is a monorepo based on git subtrees that pulls together various spiffworkflow-related projects. FYI, some scripts:

ls bin | grep subtree

License

SpiffArena's main components are published under the terms of the GNU Lesser General Public License (LGPL) Version 3.

Support

You can find us on our Discord Channel. Commercial support for SpiffWorkflow is available from Sartography.