app-template/app/docs/en/guide/quick-start.md

Get started

Goal: a running app and a login screen in a few minutes.

What you need

• Node.js 22 or newer
• Yarn 4 (enable via Corepack)
• No database server; local SQLite is the default

Four steps

1. Install

corepack enable
yarn install

2. Config

cp .env.example .env

Local defaults are fine. TURSO_DATABASE_URL already points at file:local.db.

To mount a drive you also need a secret (used to encrypt saved drive passwords):

openssl rand -hex 32

Put it in .env as MEDIA_SECRET_KEY.

3. Database and admin

yarn db:push
yarn db:seed

db:seed creates admin / admin123. Change that password before going public.

4. Run

yarn dev:web

Open http://localhost:4321. English is at /en, Chinese at /zh-CN.

After login you should see:

• Library — your shows
• Browse — folders on the drive
• Mounts — drive connections
• Danmaku — on/off and style
• Watch — the player page

Next

1. Mount a drive
2. Play something
3. Scan into the library

Commands

Command	Does
yarn dev:web	Dev server on port 4321
yarn build:web	Build the web app
yarn docs:dev	Preview these docs
yarn typecheck	Type check
yarn lint	Lint