sartography
/
spiff-arena
mirror of https://github.com/sartography/spiff-arena.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
spiff-arena/spiffworkflow-backend
History
jasquat 6944f87c8a Feature/view completed user forms (#464) 
* added modal and table to view completed forms w/ burnettk

* avoid making api calls for tab components on instance show page w/ burnettk

* show id when no task name and fix cognitive complexity warning in an embarrassing way

* removed some commented out code

* made human task attributes optional and noted them in frontend interfaces w/ burnettk

* removed draft completed tasks component w/ burnettk

---------

Co-authored-by: jasquat <jasquat@users.noreply.github.com>
Co-authored-by: burnettk <burnettk@users.noreply.github.com>
 		2023-09-07 12:04:10 -04:00
..
bin Feature/business end states (#333) 2023-09-07 10:10:44 -04:00
keycloak clean up 2023-05-26 12:40:47 -04:00
local_wheels spiff-element-units integration (#214) 2023-04-17 14:49:38 -04:00
log
…
migrations Feature/business end states (#333) 2023-09-07 10:10:44 -04:00
src/spiffworkflow_backend Feature/view completed user forms (#464) 2023-09-07 12:04:10 -04:00
tests Feature/group mapping from keycloak (#457) 2023-09-07 11:17:40 -04:00
.cookiecutter.json
…
.darglint
…
.flake8 pyl and turn back on autoreload for homepage w/ burnettk 2023-04-13 16:56:49 -04:00
.gitattributes
…
.gitignore removed coverage.xml file and ignore it in git in the future 2023-08-04 14:05:32 -04:00
.pre-commit-config.yaml drop python 3.9 and remove unused libs 2023-05-27 18:17:51 -04:00
.readthedocs.yml
…
.snyk Bump flask for safety (#304) 2023-06-06 17:33:48 -07:00
.tool-versions
…
CODE_OF_CONDUCT.rst
…
Dockerfile use mysqlclient instead of mysql-connect w/ burnettk (#358) 2023-07-12 19:44:49 +05:30
LICENSE.rst
…
README.rst drop python 3.9 and remove unused libs 2023-05-27 18:17:51 -04:00
codecov.yml
…
conftest.py enable flake8-bandit, cut off all http requests at 15 seconds to avoid hanging process, ignore xml lib spiff uses 2023-05-30 19:53:26 -04:00
docker-compose.yml feature/fix-run-scheduler-config (#456) 2023-08-31 16:09:26 -04:00
poetry.lock Support lazy loading call activities with human tasks (#450) 2023-09-07 10:33:38 -04:00
pyproject.toml Support lazy loading call activities with human tasks (#450) 2023-09-07 10:33:38 -04:00
sonar-project.properties Feature/pin spiff in ci (#428) 2023-08-03 11:49:30 -04:00
wsgi.py let ruff sort imports and ditch duplicative pre-commit linters 2023-05-26 20:01:08 -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.10+
* 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