mirror of
https://github.com/status-im/spiff-arena.git
synced 2025-01-12 03:04:12 +00:00
70480e9f91
945b3c0d Merge pull request #151 from Natalia-Fominykh/patch-1 246e160b Update demo.yml ed7185a5 Merge pull request #139 from sartography/dependabot/pip/docs/sphinx-5.3.0 4852e3f1 Bump sphinx from 5.2.3 to 5.3.0 in /docs f1e887e7 Merge pull request #127 from sartography/dependabot/pip/pyupgrade-3.1.0 2821bfbc Bump pyupgrade from 2.38.4 to 3.1.0 git-subtree-dir: spiffworkflow-backend git-subtree-split: 945b3c0d723849f0a62f18c35e3e4a6f2846bf64
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