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

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.51.tar.gz (4.5 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.51-py3-none-any.whl (4.5 MB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for music_assistant_frontend-2.17.51.tar.gz
Algorithm Hash digest
SHA256 6fe142c845d12f7575260676c57ccda01f7ada70ab3be87d4d3c9392cf467eeb
MD5 0ec5962e005e748691976e298c8fd0c9
BLAKE2b-256 e5cb368de5e4190a5249e4b286f5a3363d3a5f808da5dce7ccdfefceaf503546

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for music_assistant_frontend-2.17.51-py3-none-any.whl
Algorithm Hash digest
SHA256 61c34ab1014cf58dc3bc804ab59ea85d43e4a8d03799365b4e7429535b855991
MD5 b9648bf14a735a310e341a2374bbf4f8
BLAKE2b-256 caabb7a43987fa57efbc345839f83d097104ba172953f139d9ffd642ad6ac1c6

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