spiff-arena/spiffworkflow-backend
jasquat fe4dc14b8d Feature/docker CVE issues (#558)
* updated Dockerfile to try to remove security vulnerabilities w/ burnettk

* we require curl for health checks w/ burnettk

* try to scan docker image in ci

* use Dockerfile from backend w/ burnettk

* continue-on-error w/ burnettk

* attempt to elevate permissions of snyk w/ burnettk

* added snyk security github workflow w/ burnettk

* fixed location of constraints w/ burnettk

* add in or true for snyk tests w/ burnettk

* sent the snyk token w/ burnettk

* specify the directory for the sarif file w/ burnettk

* updated spiffworkflow-connector-command for snyk issue w/ burnettk

* updated sql statements sanitize input

* ignore issues for debug_controller and check frontend with snyk w/ burnettk

* updated babel and electron for snyk w/ burnettk

* some more updates to fix vulnerabilities w/ burnettk

* prune repeated deps for frontend builds since

* uncomment ci code so it runs again and use node for frontend base image w/ burnettk

* fixed backend image name w/ burnettk

* pyl w/ burnettk

---------

Co-authored-by: jasquat <jasquat@users.noreply.github.com>
2023-10-19 14:22:52 -04:00
..
bin Feature/data migrator tests (#546) 2023-10-12 14:29:51 -04:00
keycloak pyl w/ burnettk 2023-10-06 13:36:24 -04:00
local_wheels spiff-element-units integration (#214) 2023-04-17 14:49:38 -04:00
log
migrations Keyed key/value data store implementation (#548) 2023-10-17 10:59:01 -04:00
realmstuff ignore process instance not found in terms of sentry notification 2023-10-01 12:36:00 -04:00
src/spiffworkflow_backend Feature/docker CVE issues (#558) 2023-10-19 14:22:52 -04:00
tests Feature/error boundary (#552) 2023-10-18 14:00:12 -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 debugging function 2023-09-11 16:56:27 -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 Feature/docker CVE issues (#558) 2023-10-19 14:22:52 -04:00
.tool-versions
CODE_OF_CONDUCT.rst
Dockerfile Feature/docker CVE issues (#558) 2023-10-19 14:22:52 -04:00
LICENSE.rst
README.rst update README 2023-10-13 23:32:01 -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 do not run the background scheduler in ci for cypress tests 2023-09-08 10:03:36 -04:00
poetry.lock Feature/docker CVE issues (#558) 2023-10-19 14:22:52 -04:00
pyproject.toml Feature/error boundary (#552) 2023-10-18 14:00:12 -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
---------------

See detailed instructions at the root of spiff-arena, but:

* 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`_.


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
.. _PyPI: https://pypi.org/
.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
.. _file an issue: https://github.com/sartography/spiffworkflow-arena/issues
.. github-only