Nuclear Documentation
Nuclear - Music streaming app for your desktop
Nuclear is a free, open-source music player without ads or tracking. Search for any song or artist, build playlists, and start listening. This documentation is for both users and developers.
Quick links
For users
Themes: Nuclear supports theming. You can load your own JSON themes or choose built‑ins.
Plugins: Extend Nuclear with plugins. There is no sandbox, plugins can control the player directly. Only install plugins you trust.
What is in this repo?
This is a pnpm/turbo monorepo with these major packages:
@nuclearplayer/player - Main Tauri app (React + Rust)
@nuclearplayer/ui - Shared UI components
@nuclearplayer/themes - Theming system and utilities
@nuclearplayer/plugin-sdk - Plugin framework and helpers
@nuclearplayer/model - Shared data model
@nuclearplayer/hifi - Advanced HTML5 audio engine
@nuclearplayer/storybook - Component demos
@nuclearplayer/tailwind-config - Shared Tailwind v4 CSS config
@nuclearplayer/docs - This documentation
For developers
Tech highlights
TypeScript everywhere
Tauri (desktop shell)
React 18
Tailwind v4 configured via CSS (@theme/@layer), no tailwind.config.js
TanStack Router (routing)
TanStack Query v5 (HTTP and client‑side server state; no backend server)
Vitest + React Testing Library (tests)
Coverage via V8 with CI reporting
Common workspace tasks
Run these from the repo root:
Last updated