Skip to content

Installation

Prerequisites

Section titled “Prerequisites”
  • Python 3.11 or higher
  • Poetry

1. Clone the Repository

Section titled “1. Clone the Repository”
Terminal window
git clone https://gitlab.com/leaf-framework/leaf-graft.git
cd graft

2. Install Dependencies

Section titled “2. Install Dependencies”
Terminal window
poetry install

3. Run GRAFT

Section titled “3. Run GRAFT”
Terminal window
poetry run python app/main.py

Open http://localhost:8000 in your browser.

On first launch, open the Database Settings tab to configure your WebSocket endpoint and data source.

Docker (alternative)

Section titled “Docker (alternative)”
Terminal window
./build.sh

This builds and starts the container, serving GRAFT at http://localhost:8000.

To pass WebSocket credentials:

Terminal window
docker run -p 8000:8000 -e WS_USERNAME=myuser -e WS_PASSWORD=mypass graft

Common Issues

Section titled “Common Issues”

poetry: command not found : Install Poetry: curl -sSL https://install.python-poetry.org | python3 -

ModuleNotFoundError on startup : Run poetry install again to ensure all dependencies are present.

Dashboard does not open automatically : Navigate manually to http://localhost:8000 in your browser.