grafixeyehero / jellyfin-vue

A modern web client for Jellyfin based on Vue.

Jellyfin Vue

Part of the Jellyfin Project

---

This is an experimental web client for Jellyfin based on Vue.js. We welcome all contributions and pull requests! If you have a larger feature in mind please open an issue so we can discuss the implementation before you start.

Build Process

Dependencies

• Node.js LTS >=16.13.0 <17.0.0
• npm >=8.1.0 (included in Node.js)
• Jellyfin Server >=10.7.0

Getting Started

1. Clone or download this repository.

   git clone https://github.com/jellyfin/jellyfin-vue.git
   cd jellyfin-vue

2. Install the build dependencies in the project directory.

   npm install

3. Run the web client with Nuxt as a server for local development.

   npm start

   The client will be available at http://127.0.0.1:3000 by default.

   Build for production

   When you're ready to deploy the client, you must build the client specifically production:

   npm run build

   Build output will be available under the src/dist folder.

Other build features

Running a production build

Instead of a development version, you can run a server with a production-ready build of the client directly with Nuxt, so you can verify in advance how the client will work in a production environment:

npm run prod

Although the build of the client is production-ready, Nuxt's own HTTP server should never be exposed directly to the internet and a proper hosting tool like Nginx should always be used instead.

Server-Side Rendering (SSR)

This client fully supports Server-Side Rendering. All the commands listed above have their SSR siblings:

npm run build:ssr
npm run start:ssr
npm run prod:ssr

Running standalone

When building the SSR version of the client, all the dependencies (including those only relevant for development) will be included. If you don't plan to contribute or customize the client, these dependencies won't be useful at all for you. In order to save some space at runtime, you can specify to npm that you want only runtime dependencies and build an standalone version of the client:

npm install --production
npm run build:ssr:standalone

Contributing

We provide a devcontainer to help you setup your environment.

The project also contains recommended extensions for Visual Studio Code, which will help you with syntax style and development.

Finally, we provide useful pre-commit hooks via Husky, as well as Comitizen integration, in order to help you respect the style and naming conventions used throughout this project.

For more information about how to contribute to this project, see CONTRIBUTING.md