mirrors/jellyfin-web
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin-web synced 2025-03-30 19:56:21 +00:00
Code Activity

Update directory structure docs

Browse source
This commit is contained in:
Bill Thornton 2025-01-24 11:54:19 -05:00
parent 70cc5bb55d
commit d8601f835f
1 changed files with 10 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -73,6 +73,10 @@ Jellyfin Web is the frontend used for most of the clients available for end user
## Directory Structure ## Directory Structure
> [!NOTE]
> We are in the process of refactoring to a [new structure](https://forum.jellyfin.org/t-proposed-update-to-the-structure-of-jellyfin-web) based on [Bulletproof React](https://github.com/alan2207/bulletproof-react/blob/master/docs/project-structure.md) architecture guidelines.
> Most new code should be organized under the appropriate app directory unless it is common/shared.
``` ```
. .
└── src └── src
@ -82,8 +86,9 @@ Jellyfin Web is the frontend used for most of the clients available for end user
│   └── stable # Classic (stable) app layout and routes │   └── stable # Classic (stable) app layout and routes
├── assets # Static assets ├── assets # Static assets
├── components # Higher order visual components and React components ├── components # Higher order visual components and React components
├── controllers # Legacy page views and controllers 🧹 ├── constants # Common constant values
├── elements # Basic webcomponents and React wrappers 🧹 ├── controllers # Legacy page views and controllers 🧹 ❌
├── elements # Basic webcomponents and React equivalents 🧹
├── hooks # Custom React hooks ├── hooks # Custom React hooks
├── lib # Reusable libraries ├── lib # Reusable libraries
│   ├── globalize # Custom localization library │   ├── globalize # Custom localization library
@ -91,13 +96,14 @@ Jellyfin Web is the frontend used for most of the clients available for end user
│   ├── navdrawer # Navigation drawer library for classic layout │   ├── navdrawer # Navigation drawer library for classic layout
│   └── scroller # Content scrolling library │   └── scroller # Content scrolling library
├── plugins # Client plugins ├── plugins # Client plugins
├── scripts # Random assortment of visual components and utilities 🐉 ├── scripts # Random assortment of visual components and utilities 🐉 ❌
├── strings # Translation files ├── strings # Translation files (only commit changes to en-us.json)
├── styles # Common app Sass stylesheets ├── styles # Common app Sass stylesheets
├── themes # CSS themes ├── themes # CSS themes
├── types # Common TypeScript interfaces/types ├── types # Common TypeScript interfaces/types
└── utils # Utility functions └── utils # Utility functions
``` ```
- ❌ — Deprecated, do **not** create new files here
- 🧹 — Needs cleanup - 🧹 — Needs cleanup
- 🐉 — Serious mess (Here be dragons) - 🐉 — Serious mess (Here be dragons)