2022-06-01 15:17:25 +00:00
|
|
|
Spiffworkflow Backend
|
2022-05-13 17:42:42 +00:00
|
|
|
==========
|
|
|
|
|
|
2022-09-09 21:07:46 +00:00
|
|
|
|Tests| |Codecov|
|
2022-05-13 17:42:42 +00:00
|
|
|
|
|
|
|
|
|pre-commit| |Black|
|
|
|
|
|
|
2022-06-01 15:17:25 +00:00
|
|
|
.. |Tests| image:: https://github.com/sartography/spiffworkflow-backend/workflows/Tests/badge.svg
|
|
|
|
|
:target: https://github.com/sartography/spiffworkflow-backend/actions?workflow=Tests
|
2022-05-13 17:42:42 +00:00
|
|
|
:alt: Tests
|
2022-06-01 15:17:25 +00:00
|
|
|
.. |Codecov| image:: https://codecov.io/gh/sartography/spiffworkflow-backend/branch/main/graph/badge.svg
|
|
|
|
|
:target: https://codecov.io/gh/sartography/spiffworkflow-backend
|
2022-05-13 17:42:42 +00:00
|
|
|
: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
|
|
|
|
|
--------
|
|
|
|
|
|
2022-06-26 22:46:41 +00:00
|
|
|
* Backend API portion of the spiffworkflow engine webapp
|
2022-05-13 17:42:42 +00:00
|
|
|
|
|
|
|
|
|
2022-07-22 14:54:50 +00:00
|
|
|
Running Locally
|
|
|
|
|
---------------
|
2022-05-13 17:42:42 +00:00
|
|
|
|
2022-07-22 14:54:50 +00:00
|
|
|
* Install libraries using poetry:
|
2022-07-22 15:00:34 +00:00
|
|
|
|
2022-07-22 14:56:04 +00:00
|
|
|
.. code:: console
|
2022-07-22 15:00:34 +00:00
|
|
|
|
2022-07-22 14:56:04 +00:00
|
|
|
$ poetry install
|
2022-05-13 17:42:42 +00:00
|
|
|
|
2022-07-22 14:54:50 +00:00
|
|
|
* Setup the database - currently requires mysql:
|
2022-07-22 15:00:34 +00:00
|
|
|
|
2022-07-22 14:56:04 +00:00
|
|
|
.. code:: console
|
2022-07-22 15:00:34 +00:00
|
|
|
|
2022-09-16 18:51:41 +00:00
|
|
|
$ ./bin/recreate_db clean
|
2022-05-13 17:42:42 +00:00
|
|
|
|
2022-07-22 14:54:50 +00:00
|
|
|
* Run the server:
|
2022-07-22 15:00:34 +00:00
|
|
|
|
2022-07-22 14:56:04 +00:00
|
|
|
.. code:: console
|
2022-07-22 15:00:34 +00:00
|
|
|
|
2022-07-22 14:56:04 +00:00
|
|
|
$ ./bin/run_server_locally
|
2022-05-13 17:42:42 +00:00
|
|
|
|
|
|
|
|
|
2022-07-22 14:54:50 +00:00
|
|
|
Requirements
|
|
|
|
|
------------
|
2022-05-13 17:42:42 +00:00
|
|
|
|
2022-07-22 14:54:50 +00:00
|
|
|
* Python 3.9+
|
|
|
|
|
* Poetry
|
2022-05-13 17:42:42 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Contributing
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Contributions are very welcome.
|
|
|
|
|
To learn more, see the `Contributor Guide`_.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Distributed under the terms of the `MIT license`_,
|
2022-06-01 15:17:25 +00:00
|
|
|
*Spiffworkflow Backend* is free and open source software.
|
2022-05-13 17:42:42 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
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
|
2022-06-01 15:17:25 +00:00
|
|
|
.. _file an issue: https://github.com/sartography/spiffworkflow-backend/issues
|
2022-05-13 17:42:42 +00:00
|
|
|
.. _pip: https://pip.pypa.io/
|
|
|
|
|
.. github-only
|
|
|
|
|
.. _Contributor Guide: CONTRIBUTING.rst
|
2022-06-01 15:17:25 +00:00
|
|
|
.. _Usage: https://spiffworkflow-backend.readthedocs.io/en/latest/usage.html
|
