a71af6e40f
* Update README.md
Some notes for people that might want to run full-on native, with detail about how Mac hijacks port 7000 and how to get around it.
* Revert "Update README.md"
This reverts commit
|
||
|---|---|---|
| .github | ||
| bin | ||
| connector-proxy-demo | ||
| docs | ||
| spiffworkflow-backend | ||
| spiffworkflow-frontend | ||
| .coderabbit.yaml | ||
| .darglint | ||
| .flake8 | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| .readthedocs.yaml | ||
| .tool-versions | ||
| CONTRIBUTING.rst | ||
| Jenkinsfile | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| dev.Dockerfile | ||
| dev.docker-compose.yml | ||
| docker-compose.yml | ||
| editor.docker-compose.yml | ||
| poetry.lock | ||
| pyproject.toml | ||
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, local
Remember, if you don't need a full-on native dev experience, you can run with docker (see below), which saves you from all the native setup. If you have issues with the local dev setup, please consult the troubleshooting guide.
There are three prerequisites for non-docker local development:
- python - asdf-vm works well for installing this.
- poetry -
pip install poetryworks - mysql - the app also supports postgres. and sqlite, if you are talking local dev).
When these are installed, you are ready for:
cd spiffworkflow-backend
poetry install
./bin/recreate_db clean
./bin/run_server_locally
On a Mac, port 7000 (used by the backend) might be hijacked by Airplay. For those who upgraded to MacOS 12.1 and are running everything locally, your AirPlay receiver may have started on Port 7000 and your server (which uses port 7000 by default) may fail due to this port already being used. You can disable this port in System Preferences > Sharing > AirPlay receiver.
Keycloak Setup
You will want an openid server of some sort for authentication. There is one built in to the app that is used in the docker compose setup for simplicity, but this is not to be used in production, and non-compose defaults use a separate keycloak container by default. You can start it like this:
./keycloak/bin/start_keycloak
It'll be running on port 7002 If you want to log in to the keycloak admin console, it can be found at http://localhost:7002, and the creds are admin/admin (also logs you in to the app if running the frontend)
Frontend Setup, local
First install nodejs (also installable via asdf-vm), ideally the version in .tool-versions (but likely other versions will work). Then:
cd spiffworkflow-frontend
npm install
npm start
Assuming you're running Keycloak as indicated above, you can log in with admin/admin.
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.
Using Docker for Local Development
If you have docker and docker compose, as an alternative to locally installing the required dependencies, you can leverage the development docker containers and Makefile while working locally. To use, clone the repo and run make. This will build the required images, install all dependencies, start the servers and run the linting and tests. Once complete you can open the app and code changes will be reflected while running.
After the containers are set up, you can run make start-dev and make stop-dev to start and stop the servers. If the frontend or backend lock file changes, make dev-env will recreate the containers with the new dependencies.
Please refer to the Makefile as the source of truth, but for a summary of the available make targets:
| Target | Action |
|---|---|
| dev-env | Builds the images, sets up the backend db and installs npm and poetry dependencies |
| start-dev | Starts the frontend and backend servers, also stops them first if they were already running |
| stop-dev | Stops the frontend and backend servers |
| be-tests-par | Runs the backend unit tests in parallel |
| fe-lint-fix | Runs npm lint:fix in the frontend container |
| run-pyl | Runs all frontend and backend lints, backend unit tests |
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
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. Please contact us via the schedule a demo link on the SpiffWorkflow website to discuss your needs.