spiff-arena/docs/dev/index.md
Kevin Burnett fc74924a6d
Tech docs (#1527)
* tech docs

* more tech docs

* add process doc

* deploy docs

* doc deployment

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2024-05-21 12:03:48 -07:00

1.2 KiB

Technical Overview

Components

graph TD
subgraph spiff-arena
    Backend
    Frontend
end
subgraph Backend
    subgraph SpiffWorkflow lib
    end
end
subgraph Frontend
    subgraph bpmn-js-spiffworkflow lib
    end
end
Frontend -- uses REST API --> Backend
Backend -- delegates to --> C
Backend -- persists to --> DB
DB[(mysql/postgres)]
C[Connector Proxy]

SpiffArena is a system that allows users to build and execute BPMN diagrams. It is composed of three applications, spiffworkflow-frontend, spiffworkflow-backend, and, optionally, a connector proxy.

Source code layout

From a source code perspective, there are three repositories that may be of interest: