Aurora
Aurora UI
Section titled “Aurora UI”Aurora is a premium Jellyfin frontend built with TanStack Start and React. It keeps Jellyfin as the source of truth while layering on a more cinematic home experience, richer detail views, embedded playback, favorites, genre browsing, and translation-ready UI foundations.
Version
Section titled “Version”- Current release: 1.4.0
- Status:
Unreleasedchanges are present on main - GHCR image:
ghcr.io/get-coral/aurora-ui
Highlights
Section titled “Highlights”- Jellyfin-powered home screen with featured, continue watching, favorites, and recommendation rails
- Embedded playback with progress sync back to Jellyfin
- Rich title detail views with cast, related titles, and series episode context
- Movie and series library pages with genre browsing, sorting, and pagination
- My List / Favorites workflow backed by Jellyfin favorites
- Translation-ready UI with locale files contributors can extend
- Local-first onboarding backed by SQLite so self-hosting doesn’t require an external database
- TanStack Start - React SSR framework
- React 19
- TanStack Router + TanStack Query
- Tailwind CSS v4
- Jellyfin API
Getting Started
Section titled “Getting Started”Prerequisites
Section titled “Prerequisites”- Node.js 18+
- pnpm (or npm/yarn)
- Running Jellyfin server
Installation
Section titled “Installation”- Clone the repository:
git clone https://github.com/Get-Coral/aurora.gitcd aurora- Install dependencies:
pnpm install- Configure environment variables:
cp .env.example .env- Set your Jellyfin URL and credentials:
JELLYFIN_URL=http://your-server:8096JELLYFIN_API_KEY=your-api-keyJELLYFIN_USER_ID=your-user-id- Start development server:
pnpm devAurora will be available at http://localhost:3000
Features in Detail
Section titled “Features in Detail”Home Screen
Section titled “Home Screen”- Personalized welcome with user avatars
- Featured content rail
- Continue watching recommendations
- Favorites collection
- New releases
Browse & Search
Section titled “Browse & Search”- Browse by genre
- Full-text search
- Library browsing
- Advanced filtering and sorting
Playback
Section titled “Playback”- Embedded video player
- Progress tracking
- Resume from reading position
- Cast information
- Related content suggestions
User Preferences
Section titled “User Preferences”- Favorites management
- Playback preferences
- Theme customization
- Language selection
Development
Section titled “Development”Aurora uses TanStack Start for server-side rendering with:
- File-based routing in
src/routes/ - API endpoints for backend integration
- React Server Components for data fetching
- Client-side hydration for interactivity
Key directories:
Section titled “Key directories:”src/routes/- Page components and API endpointssrc/components/- Reusable UI componentssrc/lib/- Utilities and helperssrc/integrations/- Third-party service integration
Deployment
Section titled “Deployment”Aurora can be deployed to:
- Vercel
- Docker (Dockerfile included)
- Self-hosted servers
For production builds:
pnpm buildpnpm previewContributing
Section titled “Contributing”Aurora is open source and welcomes contributions. See the Contributing guide for details.