Getting Started

SpinDeck is a cross-platform vinyl visualization player. It organizes playlists in your browser, displays them on a 3D album shelf, and controls playback in third-party music apps.

Requirements

• Node.js ≥ 18
• pnpm 9.x

Install

git clone https://github.com/dongguacute/SpinDeck.git
cd SpinDeck
pnpm install

Web Development

Start the dev server from the monorepo root:

pnpm dev

Or run only the web app:

pnpm --filter @spindeck/web dev

Open the local URL printed in your terminal.

Build for Production

pnpm build
pnpm --filter @spindeck/web start

Other Commands

pnpm lint          # Lint
pnpm check-types   # Type check
pnpm format        # Format code

See Desktop App for the Tauri shell, or Supported Platforms for music service compatibility.

Extending the UI

• Extending @spindeck/ui — Theme families and the Material Contract
• Extending @spindeck/vinyl-ui — Vinyl player visual styles

Contributors

dongguacute

Changelog

Last edited 1 minute ago

View full history

d0143c3-feat: update dependencies and enhance server runtime validation