sartography
/
spiff-arena
mirror of https://github.com/sartography/spiff-arena.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
SpiffWorkflow is a software development platform for building, running, and monitoring executable diagrams https://www.spiffworkflow.org/
35 Commits 39 Branches 60 Tags 124 MiB
Python 61.8%
TypeScript 32.4%
Shell 2.9%
JavaScript 1.1%
CSS 1%
Other 0.8%
Go to file
burnettk 65283df3cb Squashed 'spiffworkflow-backend/' changes from 952a1af5a..3c677c751 
3c677c751 update sphinx-autoapi

git-subtree-dir: spiffworkflow-backend
git-subtree-split: 3c677c751b84ff8ddd1372b4b01c15fe7e10e0f1
 		2022-10-24 22:35:36 -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 22766521..b978f502 2022-10-21 16:28:09 -04:00
src/spiffworkflow_backend Squashed 'spiffworkflow-backend/' changes from 945b3c0d..653a86b1 2022-10-24 17:53:02 -04:00
tests Squashed 'spiffworkflow-backend/' changes from b978f502..797c99a7 2022-10-21 16:46:41 -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/' content from commit 50f28073 2022-10-12 10:22:22 -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 952a1af5a..3c677c751 2022-10-24 22:35:36 -04:00
pyproject.toml Squashed 'spiffworkflow-backend/' changes from 952a1af5a..3c677c751 2022-10-24 22:35:36 -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