Vian

A video annotation software built with Electron and Vue.js.

Project Setup: Electron

Download libraries

• Download the TransNetv2 onnx model here and move it to resources
• Download pre-compiled ffmpeg libraries here and move it to ffmpeglibs.
• Download pre-compiled onnxruntime version 1.20.1 here (for Windows, Mac OS, Linux) and move it to onnxlibs.

Install

$ npm install

Development

$ npm run dev

Build

# For windows
$ npm run build:win

# For macOS
$ npm run build:mac

# For Linux
$ npm run build:linux

Project Setup: Web

Development

Install the dependecies (example using uv and apt):

$ cd server
$ uv venv
$ apt install redis

Start redis, celery, fastapi, and vite:

$ redis-server
$ npm run web
$ cd server
$ uv run celery -b redis://localhost:6379/0 --result-backend redis://localhost:6379/0 -A tasks worker
$ uv run fastapi run main.py

Deployment via Docker

$ cd docker
$ docker compose up --build

Linting

Before committing, run:

# Check JavaScript/TypeScript code style
npm run lint

# Linting Python
cd server
uvx ruff check
uvx pyright