yoink

Building from source is useful for development or if you want to run yoink without Docker. If you just want to run the app, Docker Compose is still the recommended option for most users.

Prerequisites

Rust: stable toolchain
mise: manages bun, sea-orm-cli, and other dev tools
bun: installed automatically by mise

Setup

Clone the repository

git clone https://github.com/FlyinPancake/yoink.git
cd yoink

Install build dependencies

You need to have Rust installed (via rustup) and then run:

mise install

This installs bun and other development tools defined in mise.toml.

Install frontend dependencies and build frontend

cd frontend && bun install && cd ..

Configure environment

cp .env.example .env

Edit .env to configure your providers and settings. See the configuration reference for all available variables.

Run in development mode

mise run dev

This starts both the backend (with auto-rebuild on changes) and the frontend dev server. The UI is available at http://localhost:5173.

Release Build

For a production build without Docker:

mise run build-frontend
mise run run-server --release

The UI will be available at http://localhost:3000. The frontend is embedded into the server binary.

From Source