Music Assistant frontend (Vue PWA)

The Music Assistant frontend/panel is developed in Vue, development instructions below.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for `.vue` Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

Disable the built-in TypeScript Extension

1. Run Extensions: Show Built-in Extensions from VSCode's command palette 2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)

Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

nvm use node
pnpm install

Compile and Hot-Reload for Development

pnpm dev

This will launch an auto-reload development environment (usually at http://localhost:3000) Open the url in the browser and a popup will ask the location of the MA server. You can either connect to a locally launched dev server or an existing running server on port 8095.

Type-Check, Compile and Minify for Production

pnpm build

Lint with ESLint

pnpm lint

UI Framework

This project is migrating from Vuetify to shadcn-vue as its primary UI component library.

Development Guidelines

Components

Size limit: Keep components under 300–400 lines. If a component grows beyond this, split it into smaller, focused sub-components.
Single responsibility: Each component should do one thing well. Extract repeated logic or UI patterns into reusable components.
Composition over complexity: Prefer composing small components rather than building monolithic ones with many responsibilities.

UI Components

Use shadcn-vue: All new UI should use shadcn-vue components located in src/components/ui/. Do not introduce new Vuetify components.
Extend, don't override: If a shadcn-vue component needs customization, extend it via props or slots rather than overriding styles globally.
Avoid inline styles: Use Tailwind utility classes for styling. Avoid style="" attributes except for dynamic values that cannot be expressed as classes.
Tailwind first: Style with Tailwind utility classes rather than a scoped

music-assistant/frontend: Repository hosting the source of the (Vue3) frontend of Music Assistant