mirror of
https://github.com/status-im/spiff-arena.git
synced 2025-01-09 17:55:48 +00:00
ac929cbae7
e748b1804 quick patch so I can see the error message. 94908a9b9 Merge pull request #155 from sartography/dependabot/pip/flake8-bugbear-22.10.25 d7ba33c03 Bump flake8-bugbear from 22.9.23 to 22.10.25 bf9db9521 Merge pull request #154 from sartography/dependabot/pip/reorder-python-imports-3.9.0 4a2b12efc Bump reorder-python-imports from 3.8.5 to 3.9.0 git-subtree-dir: spiffworkflow-backend git-subtree-split: e748b18047e611fb635da89dad563548fff7e00f
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