| Name | music-assistant-frontend JSON |
| Version |
2.9.9
JSON |
| download |
| home_page | None |
| Summary | The Music Assistant frontend |
| upload_time | 2024-10-22 19:29:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9.0 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Music Assistant frontend (Vue PWA)
The Music Assistant frontend/panel is developed in Vue, development instructions below.
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin).
## 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)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin) 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](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) 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](https://vitejs.dev/config/).
## Project Setup
```sh
nvm use node
yarn install
```
### Compile and Hot-Reload for Development
```sh
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
```sh
yarn build
```
### Lint with [ESLint](https://eslint.org/)
```sh
yarn lint
```
# Translation Management
We use Lokalise to manage the translation files for the Music Assistant frontend
[<img src="https://github.com/lokalise/i18n-ally/raw/screenshots/lokalise-logo.png?raw=true" alt="Lokalise logo" width="275px">](https://lokalise.com)
### 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/.
Raw data
{
"_id": null,
"home_page": null,
"name": "music-assistant-frontend",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "The Music Assistant Authors <m.vanderveldt@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/1e/64/0b1c9e988b8619e6e7a0f7a920022631c68ad023e94e184bc17da64a7094/music-assistant-frontend-2.9.9.tar.gz",
"platform": "any",
"description": "# Music Assistant frontend (Vue PWA)\n\nThe Music Assistant frontend/panel is developed in Vue, development instructions below.\n\n## Recommended IDE Setup\n\n[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin).\n\n## Type Support for `.vue` Imports in TS\n\nTypeScript 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)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.\n\nIf the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:\n\n1. Disable the built-in TypeScript Extension\n 1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette\n 2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`\n2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.\n\n## Customize configuration\n\nSee [Vite Configuration Reference](https://vitejs.dev/config/).\n\n## Project Setup\n\n```sh\nnvm use node\nyarn install\n```\n\n### Compile and Hot-Reload for Development\n\n```sh\nyarn dev\n```\n\nThis will launch an auto-reload development environment (usually at http://localhost:3000)\nOpen the url in the browser and a popup will ask the location of the MA server.\nYou can either connect to a locally launched dev server or an existing running server on port 8095.\n\n### Type-Check, Compile and Minify for Production\n\n```sh\nyarn build\n```\n\n### Lint with [ESLint](https://eslint.org/)\n\n```sh\nyarn lint\n```\n\n# Translation Management\n\nWe use Lokalise to manage the translation files for the Music Assistant frontend\n\n[<img src=\"https://github.com/lokalise/i18n-ally/raw/screenshots/lokalise-logo.png?raw=true\" alt=\"Lokalise logo\" width=\"275px\">](https://lokalise.com)\n\n### Contributing\n\nIf 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/.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "The Music Assistant frontend",
"version": "2.9.9",
"project_urls": {
"Homepage": "https://github.com/music-assistant/frontend"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "92fb68baed8c6e49713fd3c7fda058725e3ca47e6dac49cebd4597a8c94d5ce7",
"md5": "59f83004626706181976f196ffece8df",
"sha256": "6e7320e1628bb5f5c9f5854a184a8480e8102332907bbe2369ad522936bceb65"
},
"downloads": -1,
"filename": "music_assistant_frontend-2.9.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "59f83004626706181976f196ffece8df",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 4196201,
"upload_time": "2024-10-22T19:29:16",
"upload_time_iso_8601": "2024-10-22T19:29:16.737715Z",
"url": "https://files.pythonhosted.org/packages/92/fb/68baed8c6e49713fd3c7fda058725e3ca47e6dac49cebd4597a8c94d5ce7/music_assistant_frontend-2.9.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e640b1c9e988b8619e6e7a0f7a920022631c68ad023e94e184bc17da64a7094",
"md5": "f67cf705c67e79808907c96cb424e8dc",
"sha256": "e10a5ed560b780df6fef2b69230d7ee1cd4cc46fdf398316dd7af9270524b5e4"
},
"downloads": -1,
"filename": "music-assistant-frontend-2.9.9.tar.gz",
"has_sig": false,
"md5_digest": "f67cf705c67e79808907c96cb424e8dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 4151826,
"upload_time": "2024-10-22T19:29:19",
"upload_time_iso_8601": "2024-10-22T19:29:19.060030Z",
"url": "https://files.pythonhosted.org/packages/1e/64/0b1c9e988b8619e6e7a0f7a920022631c68ad023e94e184bc17da64a7094/music-assistant-frontend-2.9.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 19:29:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "music-assistant",
"github_project": "frontend",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "music-assistant-frontend"
}
