SpiffWorkflow is a software development platform for building, running, and monitoring executable diagrams
https://www.spiffworkflow.org/
ac6706197c
55f5c8113e arena github actions a06427482b reduce matrix f5f88926a6 debug 23fbe1b2e9 lint and mypy 30ee07700f Merge remote-tracking branch 'origin/main' into feature/home_page_redesign bd38d90600 lint 201655fc0f add the username to the task list w/ burnettk e069906394 merged in main and resolved conflicts w/ burnettk 9135f74a03 added more task tables w/ burnettk 352353e48b store bpmn_file_relative_path using correct slashes w/ burnettk d02a6610bb underscore unused vars a9ecaa0431 added tasks for my open processes page w/ burnettk 74af6a4ad1 Merge remote-tracking branch 'origin/main' into feature/home_page_redesign d5330d6031 Merge remote-tracking branch 'origin/main' into feature/home_page_redesign 37d9ca8dea added home page routes and some tab stuff w/ burnettk git-subtree-dir: spiffworkflow-backend git-subtree-split: 55f5c8113e1189888672992d109e80a3d51dfa1a |
||
---|---|---|
.github | ||
bin | ||
docs | ||
keycloak | ||
log | ||
migrations | ||
src/spiffworkflow_backend | ||
tests | ||
.cookiecutter.json | ||
.darglint | ||
.flake8 | ||
.gitattributes | ||
.gitignore | ||
.pre-commit-config.yaml | ||
.readthedocs.yml | ||
.tool-versions | ||
CODE_OF_CONDUCT.rst | ||
CONTRIBUTING.rst | ||
Dockerfile | ||
LICENSE.rst | ||
README.rst | ||
codecov.yml | ||
conftest.py | ||
docker-compose.yml | ||
noxfile.py | ||
poetry.lock | ||
pyproject.toml | ||
sonar-project.properties | ||
wsgi.py |
README.rst
Spiffworkflow Backend ========== |Tests| |Codecov| |pre-commit| |Black| .. |Tests| image:: https://github.com/sartography/spiffworkflow-backend/workflows/Tests/badge.svg :target: https://github.com/sartography/spiffworkflow-backend/actions?workflow=Tests :alt: Tests .. |Codecov| image:: https://codecov.io/gh/sartography/spiffworkflow-backend/branch/main/graph/badge.svg :target: https://codecov.io/gh/sartography/spiffworkflow-backend :alt: Codecov .. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white :target: https://github.com/pre-commit/pre-commit :alt: pre-commit .. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black :alt: Black Features -------- * Backend API portion of the spiffworkflow engine webapp Running Locally --------------- * Install libraries using poetry: .. code:: console $ poetry install * Setup the database - uses mysql and assumes server is running by default: .. code:: console $ ./bin/recreate_db clean * Run the server: .. code:: console $ ./bin/run_server_locally Requirements ------------ * Python 3.9+ * Poetry Contributing ------------ Contributions are very welcome. To learn more, see the `Contributor Guide`_. License ------- Distributed under the terms of the `MIT license`_, *Spiffworkflow Backend* is free and open source software. Issues ------ If you encounter any problems, please `file an issue`_ along with a detailed description. Credits ------- This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template. .. _@cjolowicz: https://github.com/cjolowicz .. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _MIT license: https://opensource.org/licenses/MIT .. _PyPI: https://pypi.org/ .. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python .. _file an issue: https://github.com/sartography/spiffworkflow-backend/issues .. _pip: https://pip.pypa.io/ .. github-only .. _Contributor Guide: CONTRIBUTING.rst .. _Usage: https://spiffworkflow-backend.readthedocs.io/en/latest/usage.html (test)