Spaces:
Sleeping
Sleeping
File size: 1,520 Bytes
28cbd5e 19e3421 28cbd5e 19e3421 28cbd5e 19e3421 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | ---
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
<img src="vizzy_icon.png" alt="Vizzy Icon" width="150px">
This is the **backend server** that supports the [Vizzy Chrome extension](https://github.com/sebastianschramm/vizzy-chrome-extension.git).
It handles graph recoloring, description generation, and audio narration requests.
---
## 🛠 Installation
### 1. Clone the repository
```bash
git clone https://github.com/sebastianschramm/vizzy-backend.git
cd vizzy-backend
```
### 2. Install dependencies with Poetry
```bash
poetry install
```
### 3. Start the server
```bash
uvicorn server:app --host 0.0.0.0 --port 8000 --workers 1 --log-level info
```
The server will run on [http://localhost:8000](http://localhost:8000)
---
## 🐳 Docker
You can also run the backend using Docker (it's compatible for huggingface spaces deployment):
### Build the image
```bash
docker build -t vizzy-backend .
```
### Run the container
```bash
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](LICENSE) for details.
|