18600189c8
* WIP: some initial test code to test out celery w/ burnettk * some cleanup for celery and added base model to put tasks waiting on timers * removed dup bpmn file * some more cleanup and added strategy to queue instructions * some minor code changes w/ burnettk * remove the unused next_task key from api calls since nobody uses it w/ burnettk essweine * added migration for future tasks and added test to make sure we are inserting into it w/ burnettk essweine * ensure future task run at time can be updated w/ burnettk * added table to queue instructions for end user in w/ burnettk * added test to ensure we are storing instructions for end users w/ burnettk * added progress page to display new instructions to user * ignore dup instructions on db insert w/ burnettk * some more updates for celery w/ burnettk * some pyl and test fixes w/ burnettk * fixed tests w/ burnettk * WIP: added in page to show instructions on pi show page w/ burnettk * pi show page is fully using not interstitial now w/ burnettk * fixed broken test w/ burnettk * moved background processing items to own module w/ burnettk * fixed apscheduler start script * updated celery task queue to handle future tasks and upgraded black and set its line-length to match ruff w/ burnettk * added support to run future tasks using countdown w/ burnettk * build image for celery branch w/ burnettk * poet does not exist in the image w/ burnettk * start blocking scheduler should always start the scheduler w/ burnettk * add init and stuff for this branch * make this work not just on my mac * send other args to only * added running status for process instance and use that on fe to go to show page and added additional identifier to locking system to isolate celery workers better w/ burnettk * fixed typing error that typeguard found, not sure why mypy did not w/ burnettk * do not check for no instructions on interstitial page for cypress tests on frontend w/ burnettk * do not queue process instances twice w/ burnettk * removed bad file w/ burnettk * queue tasks using strings to avoid circular imports when attmepting to queue w/ burnettk * only queue imminent new timer events and mock celery * some keyboard shortcut support on frontend and added ability to force run a process instance over the api w/ burnettk * some styles added for the shortcut menu w/ burnettk * pyl w/ burnettk * fixed test w/ burnettk * removed temporary celery script and added support for celery worker in run server locally w/ burnettk * cleaned up migrations w/ burnettk * created new migration to clean up old migrations --------- Co-authored-by: jasquat <jasquat@users.noreply.github.com> Co-authored-by: burnettk <burnettk@users.noreply.github.com>
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:
- Explore the demo site via the Getting Started Guide
- 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 - 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.