- Python 3.8 or later (may work with other versions as well)
- pip (Python package manager)
-
Clone the repository:
git clone https://github.com/freehci/freehci-appliance.git
-
Install
uvicorn
usingpip
:pip install uvicorn
-
Install the requirements:
pip install -r requirements.txt
-
Configure the Vue.js frontend to work with the FreeHCI API. Edit
html/ui/static/js/config.js
to point to your API endpoint:
window.apiBaseUrl = "http://localhost:8000/";
- Run the project using
uvicorn
:uvicorn main:app --reload
Options: --host TEXT Bind socket to this host. [default: 127.0.0.1] --port INTEGER Bind socket to this port. [default: 8000]
For more options, please visit uvicorn documentation