Spiffworkflow Backend

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:

$ poetry install

NOTE: Mysql and Postgres may require special binary files exist on your system prior to installing these libraries. Please see the PyPi mysqlclient instructions and the pre-requisites for the Postgres psycopq2 adapter Following the instructions here carefully will assure your OS has the right dependencies installed.

• Setup the database - uses mysql and assumes server is running by default:

$ ./bin/recreate_db clean

• Run the server:

$ ./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.