Skip to main content

The Music Assistant frontend

Project description

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:

  1. 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)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

nvm use node
yarn install

Compile and Hot-Reload for Development

yarn 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

yarn build

Lint with ESLint

yarn lint

UI Framework

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

Guidelines

  • All new features should be built using shadcn-vue components
  • Shadcn-vue components are located in src/components/ui/
  • When working on existing features that use Vuetify, consider refactoring them to use shadcn-vue components if you have time
  • Refer to the shadcn-vue documentation for available components and usage examples

Translation Management

We use Lokalise to manage the translation files for the Music Assistant frontend

Lokalise logo

Contributing

If you wish to assist in translating Music Assistant into a language that it currently does not support, please see here https://music-assistant.io/help/lokalise/.


A project from the Open Home Foundation

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

music_assistant_frontend-2.17.82.tar.gz (4.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

music_assistant_frontend-2.17.82-py3-none-any.whl (4.7 MB view details)

Uploaded Python 3

File details

Details for the file music_assistant_frontend-2.17.82.tar.gz.

File metadata

File hashes

Hashes for music_assistant_frontend-2.17.82.tar.gz
Algorithm Hash digest
SHA256 15851ebfeb297e5be7dc2036fa2b03d045150d17a4237130b6a844457cfbfa78
MD5 9818933339753832bbb2ed2242d6fd63
BLAKE2b-256 acc6c9981030ec49c618d1b75d40ae090f505540f28606147f0527229d518c8e

See more details on using hashes here.

File details

Details for the file music_assistant_frontend-2.17.82-py3-none-any.whl.

File metadata

File hashes

Hashes for music_assistant_frontend-2.17.82-py3-none-any.whl
Algorithm Hash digest
SHA256 972f388cdd40d82e8016850ffd6056c6e85342fe5fba2842a7da71f0f939fb8e
MD5 511fdfc66576bad34df17302367ca392
BLAKE2b-256 7707ecb3787dde3f74a36ebe6965c6a83a2e66c9226ea37a97e2b2b2b479cf91

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page