SpiffWorkflow is a software development platform for building, running, and monitoring executable diagrams https://www.spiffworkflow.org/
Go to file
Dan Funk c48f3a458b Feature/interstitial summary (#337)
* * Process instance logs and messages are now components rather than pages, and are included within tabs on the process instance page, along with the diagram.
* Removed the Zoom and Move modules when showing the readonly
  Diagram.  Assured this readonly view is resized to fit the space when possible.
* Checkbox Widget no longer displays a duplicate label.
* CSS Tweaks
  * All pages are limited to a max display width of 1440, with auto margins to center the main content on the page.
  * "Show" pages, like ProcessInstanceShow, TaskShow have the primary content limited to 1000, also with auto-margins.
  * Paragraphs, headings, blockquotes, list items are limited to a width of 640.
  * Reduced margin bottom on all breadcrumbs.
  * Slightly reduced the width and margin of tiles
  * ordered lists and unordered lists show numbers and bullets now.
* End user Instructions component can, optionally, auto-collapse, so that only a portion is displayed, along with a toggle.  This is how it is set up for the ProcessInstanceShow page.
* Greatly reduced the lag in the interstitial page when doing a re-direct.

* run_pyl

* kill console

* wait for permissionsLoaded too since we are using ability.can

* Previous change removed the top level Messages page - this re-adds it.

* I am always, ALWAYS shocked at how I can not wrap my head around when and where to use "useEffect".

This should cause the show/hide Instructions toggle to only show when useful.

* Minor cleanup on the process instance properties display.

* linting

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2023-06-16 09:53:20 -04:00
.github format date picker helper text width to match the date widget itself … (#330) 2023-06-13 20:16:26 +05:30
bin Merge remote-tracking branch 'origin/main' into feature/better_interstitial_spinner_and_suspend_message 2023-06-01 15:07:25 -04:00
connector-proxy-demo
docs Feature/interstitial summary (#337) 2023-06-16 09:53:20 -04:00
spiffworkflow-backend Revert "Feature/better subworkflow management (#331)" 2023-06-15 15:10:48 -04:00
spiffworkflow-frontend Feature/interstitial summary (#337) 2023-06-16 09:53:20 -04:00
.darglint
.flake8 pyl and turn back on autoreload for homepage w/ burnettk 2023-04-13 16:56:49 -04:00
.gitignore Editor compose (#279) 2023-05-25 15:15:58 -04:00
.pre-commit-config.yaml Typeahead datastore (#321) 2023-06-09 12:28:59 -07:00
.readthedocs.yaml use requirements.txt for readthedocs build. 2023-05-18 11:26:47 -04:00
.tool-versions
Jenkinsfile ci: sent Discord notifications for all builds 2023-06-01 20:16:17 +02:00
LICENSE
README.md update setup steps 2023-05-22 09:31:08 -07:00
docker-compose.yml use sqlite for docker compose db and use a volume so data persists w/ burnettk 2023-06-01 16:36:37 -04:00
editor.docker-compose.yml Set auth off, doesn't pass permissions (#327) 2023-06-12 10:15:25 -07:00
poetry.lock let ruff sort imports and ditch duplicative pre-commit linters 2023-05-26 20:01:08 -04: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 executable.

Please visit the SpiffWorkflow website for a Getting Started Guide to see how to run SpiffArena locally 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.

Contributing

This is a monorepo based on git subtrees that pulls together various spiffworkflow-related projects. Feel free to ignore that and drop us a pull request. If you need to push back from the monorepo to one of the individual repos, here's an example command (and find other scripts we use in the bin directory):

git subtree push --prefix=spiffworkflow-frontend git@github.com:sartography/spiffworkflow-frontend.git add_md_file

Backend Setup

First install python and poetry, and then:

cd spiffworkflow-backend
poetry install
./bin/run_server_locally

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

Requires at root:

  • .darglint
  • .flake8
  • .pre-commit-config.yaml
  • pyproject.toml

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

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.