SpiffWorkflow is a software development platform for building, running, and monitoring executable diagrams https://www.spiffworkflow.org/
Go to file
burnettk 1f25521506 Squashed 'spiffworkflow-backend/' changes from 153061d4..1092ed11
1092ed11 Merge branch 'main' of github.com:sartography/spiffworkflow-backend into main
97b96fa9 Merge commit '999e0f4d2b7a3c3665feb806fd4f00dc50f2de8e'
4d2ebbe2 Refresh token (#6)
2c47d862 Revert "Assure that the Active Task Users table is cleared out before deleting the Active Task Record."
6c1660a3 Merge commit 'eff49e1ddb2e70d62e45866b429a1350443107d0' into main
f7949ada Merge commit 'ac929cbae7717affed5fa357a56cf1a0256289d5' into main
b70804ea Merge commit '65283df3cbfe95c6cd0d69e1cc0204d91c5d535b'
5b9ad7a7 Merge commit 'a59108db95274bef304cbd9246537206d0b449cf'
038c8e68 Merge commit '835160e5a82c7e0518fa25ed7fa1168c9c435739'
aae7966b Merge commit 'a1cce807be1c4ac5f04c42d780df06c216a0de9c'
8527c6be Merge commit '7026fe1f779051f6eb99b872bcd45b14c0cbe88f'
1aa9a8da Merge commit '70480e9f91a1053531ea5db32a13a791c39fd89f'
40383711 Merge commit '9a1e33696a744527a18dbec667140edb4038ac94'
2c7b2e28 Merge commit 'd643de93e5ceaae28a6e65044cc85dd039530d2c'
e5e70161 Merge commit '2b702661f3bd9b79de887e82e5a5925d07341eb6'
b0b92474 updateing poetry lock file.
e5fd3df1 Merge commit 'f0b608789b6cdc3ef4303efac053746c98571a48'
dfe4e3e1 Merge commit 'c5a2f8b16c9a614b944a6e4610594eba1dac7b9f' into main
78dcaec3 pointless change

git-subtree-dir: spiffworkflow-backend
git-subtree-split: 1092ed11187d1b825fa1c5e18f0d96592f0b98e7
2022-10-25 16:54:06 -04:00
.github Squashed 'spiffworkflow-backend/' changes from 797c99a76..e013fc5da 2022-10-21 17:28:37 -04:00
bin Squashed 'spiffworkflow-backend/' changes from 945b3c0d..653a86b1 2022-10-24 17:53:02 -04:00
docs Squashed 'spiffworkflow-backend/' changes from 13855180..945b3c0d 2022-10-24 10:44:38 -04:00
keycloak Squashed 'spiffworkflow-backend/' changes from 68ea8bce3..952a1af5a 2022-10-24 18:20:10 -04:00
log Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
migrations Squashed 'spiffworkflow-backend/' changes from 153061d4..1092ed11 2022-10-25 16:54:06 -04:00
src/spiffworkflow_backend Squashed 'spiffworkflow-backend/' changes from 153061d4..1092ed11 2022-10-25 16:54:06 -04:00
tests Squashed 'spiffworkflow-backend/' changes from 153061d4..1092ed11 2022-10-25 16:54:06 -04:00
.cookiecutter.json Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
.darglint Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
.flake8 Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
.gitattributes Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
.gitignore Squashed 'spiffworkflow-backend/' changes from 22766521..b978f502 2022-10-21 16:28:09 -04:00
.pre-commit-config.yaml Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
.readthedocs.yml Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
.tool-versions Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
CODE_OF_CONDUCT.rst Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
CONTRIBUTING.rst Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
Dockerfile Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
LICENSE.rst Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
README.rst Squashed 'spiffworkflow-backend/' changes from 153061d4..1092ed11 2022-10-25 16:54:06 -04:00
codecov.yml Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
conftest.py Squashed 'spiffworkflow-backend/' changes from 22766521..b978f502 2022-10-21 16:28:09 -04:00
docker-compose.yml Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
noxfile.py Squashed 'spiffworkflow-backend/' changes from 5225a8b4..1e831706 2022-10-21 10:36:41 -04:00
poetry.lock Squashed 'spiffworkflow-backend/' changes from 3c677c751..e748b1804 2022-10-25 11:25:20 -04:00
pyproject.toml Squashed 'spiffworkflow-backend/' changes from 3c677c751..e748b1804 2022-10-25 11:25:20 -04:00
sonar-project.properties Squashed 'spiffworkflow-backend/' content from commit 50f28073 2022-10-12 10:22:22 -04:00
wsgi.py Squashed 'spiffworkflow-backend/' changes from eb89e9529..59e6ee2c8 2022-10-13 20:45:04 -04:00

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)