README.md

metadata

title: vizzy-server
emoji: 🐠
colorFrom: gray
colorTo: yellow
sdk: docker
pinned: false
license: apache-2.0
short_description: Vizzy backend server
startup_duration_timeout: 2h

Vizzy Backend - Making Visual Data Inclusive

This is the backend server that supports the Vizzy Chrome extension.
It handles graph recoloring, description generation, and audio narration requests.

---

🛠 Installation

1. Clone the repository

git clone https://github.com/sebastianschramm/vizzy-backend.git
cd vizzy-backend

2. Install dependencies with Poetry

poetry install

3. Start the server

uvicorn server:app --host 0.0.0.0 --port 8000 --workers 1 --log-level info

The server will run on http://localhost:8000

---

🐳 Docker

You can also run the backend using Docker (it's compatible for huggingface spaces deployment):

Build the image

docker build -t vizzy-backend .

Run the container

docker run -p 8000:7860 vizzy-backend

---

📖 API Endpoints

• POST /process – process an image
• POST /processupload – process an image from an upload form
• GET /health – health check

(Exact payloads and responses can be found in the /docs endpoint when the server is running.)

---

📜 License

Apache 2.0 License – see LICENSE for details.