Web Client for Jellyfin
Go to file
2024-11-18 17:07:24 -05:00
.devcontainer
.github Fix syntax error in push workflow 2024-10-26 21:02:29 +02:00
.vscode
scripts
src Move strict mode to page component 2024-11-18 17:07:24 -05:00
.editorconfig
.escheckrc Fix libarchive bundling 2024-09-11 10:20:11 -04:00
.eslintignore Fix eslint comment dependency 2024-09-19 09:58:41 -04:00
.eslintrc.js Fix eslint comment dependency 2024-09-19 09:58:41 -04:00
.gitattributes
.gitignore Add test coverage support 2024-06-25 10:34:49 -04:00
.npmignore
.npmrc
.nvmrc Add .nvmrc (#5842) 2024-08-20 12:24:17 -04:00
.sonarcloud.properties
.stylelintrc.json
babel.config.js Cleanup babel plugins 2024-09-11 10:29:30 -04:00
bump_version
CONTRIBUTORS.md refactor activity page to use react query requests 2024-08-21 19:24:20 -04:00
cssnano.config.js
LICENSE
package-lock.json Bump version to 10.11.0 2024-10-26 13:32:56 -04:00
package.json Bump version to 10.11.0 2024-10-26 13:32:56 -04:00
postcss.config.js
README.md Update source tree in README 2024-08-14 16:52:56 -04:00
tsconfig.json
vite.config.ts Add test coverage support 2024-06-25 10:34:49 -04:00
webpack.analyze.js
webpack.common.js Backport pull request #6284 from jellyfin-web/release-10.10.z 2024-11-03 10:54:37 -05:00
webpack.dev.js
webpack.prod.js

Jellyfin Web

Part of the Jellyfin Project


Logo Banner

GPL 2.0 License Current Release Translation Status
Donate Feature Requests Chat on Matrix Join our Subreddit

Jellyfin Web is the frontend used for most of the clients available for end users, such as desktop browsers, Android, and iOS. 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. Translations can be improved very easily from our Weblate instance. Look through the following graphic to see if your native language could use some work!

Detailed Translation Status

Build Process

Dependencies

  • Node.js
  • npm (included in Node.js)

Getting Started

  1. Clone or download this repository.

    git clone https://github.com/jellyfin/jellyfin-web.git
    cd jellyfin-web
    
  2. Install build dependencies in the project directory.

    npm install
    
  3. Run the web client with webpack for local development.

    npm start
    
  4. Build the client with sourcemaps available.

    npm run build:development
    

Directory Structure

.
└── src
    ├── apps
    │   ├── dashboard     # Admin dashboard app layout and routes
    │   ├── experimental  # New experimental app layout and routes
    │   └── stable        # Classic (stable) app layout and routes
    ├── assets            # Static assets
    ├── components        # Higher order visual components and React components
    ├── controllers       # Legacy page views and controllers 🧹
    ├── elements          # Basic webcomponents and React wrappers 🧹
    ├── hooks             # Custom React hooks
    ├── lib               # Reusable libraries
    │   ├── globalize     # Custom localization library
    │   ├── legacy        # Polyfills for legacy browsers
    │   ├── navdrawer     # Navigation drawer library for classic layout
    │   └── scroller      # Content scrolling library
    ├── plugins           # Client plugins
    ├── scripts           # Random assortment of visual components and utilities 🐉
    ├── strings           # Translation files
    ├── styles            # Common app Sass stylesheets
    ├── themes            # CSS themes
    ├── types             # Common TypeScript interfaces/types
    └── utils             # Utility functions
  • 🧹 — Needs cleanup
  • 🐉 — Serious mess (Here be dragons)