Merge remote-tracking branch 'origin/main' into feature/form_navigation
This commit is contained in:
commit
6a22ea5167
39
README.rst
39
README.rst
|
@ -42,26 +42,33 @@ Features
|
||||||
* Backend API portion of the spiffworkflow engine webapp
|
* Backend API portion of the spiffworkflow engine webapp
|
||||||
|
|
||||||
|
|
||||||
|
Running Locally
|
||||||
|
---------------
|
||||||
|
|
||||||
|
* Install libraries using poetry:
|
||||||
|
|
||||||
|
.. code:: console
|
||||||
|
|
||||||
|
$ poetry install
|
||||||
|
|
||||||
|
* Setup the database - currently requires mysql:
|
||||||
|
|
||||||
|
.. code:: console
|
||||||
|
|
||||||
|
$ ./bin/recreate_db
|
||||||
|
|
||||||
|
* Run the server:
|
||||||
|
|
||||||
|
.. code:: console
|
||||||
|
|
||||||
|
$ ./bin/run_server_locally
|
||||||
|
|
||||||
|
|
||||||
Requirements
|
Requirements
|
||||||
------------
|
------------
|
||||||
|
|
||||||
* Python 3.9+
|
* Python 3.9+
|
||||||
|
* Poetry
|
||||||
|
|
||||||
Installation
|
|
||||||
------------
|
|
||||||
|
|
||||||
You can install *Spiffworkflow Backend* via pip_ from PyPI_:
|
|
||||||
|
|
||||||
.. code:: console
|
|
||||||
|
|
||||||
$ pip install spiffworkflow-backend
|
|
||||||
|
|
||||||
|
|
||||||
Usage
|
|
||||||
-----
|
|
||||||
|
|
||||||
Please see the `Command-line Reference <Usage_>`_ for details.
|
|
||||||
|
|
||||||
|
|
||||||
Contributing
|
Contributing
|
||||||
|
|
Loading…
Reference in New Issue