3.6 KiB
3.6 KiB
NextAV Documentation
A modern, YouTube-like media library management system built with Next.js
📋 Quick Navigation
🟢 Current Features (Production Ready)
- Feature Status - Implementation overview
- Documentation Organization - Doc structure guide
Library Cluster System
Comprehensive media organization with clusters
- 📁
active/library-clusters/- Complete documentation - ✅ Status: Production ready
- 🎯 Features: Cluster management, library mapping, statistics, folder navigation
Media Streaming & Format Support
Zero-transcoding media streaming with local player fallback
- 📁
active/media-streaming/- Technical documentation - ✅ Status: Production ready
- 🎯 Features: Direct streaming, format detection, local player integration
Surprise Me Recommendations
Intelligent content discovery system
- 📁
active/recommendations/- Design & implementation - ⚠️ Status: MVP ready (3/7 algorithms)
- 🎯 Features: Multiple algorithms, media access tracking
Recent Fixes & Enhancements
Latest improvements and bug fixes
- 📁
active/fixes-enhancements/- Fix documentation - ✅ Status: Implemented and tested
- 🎯 Features: Auto-close fixes, migration guides, implementation tracking
🟡 Planned Features
- 📁
planning/- Future enhancements - 🎯 ArtPlayer Enhancement: Direct playback optimization (1 document)
📚 Archive
- 📁
archive/transcoding-legacy/- Removed transcoding features - 📁
archive/deployment-legacy/- Historical deployment info
🚀 Getting Started
Development Setup
# Install dependencies
pnpm install
# Run development server
pnpm dev
# Build for production
pnpm build
Docker Deployment
# Build and run with Docker Compose
docker-compose up -d
# Access application
open http://localhost:3000
📊 Feature Implementation Status
| Feature | Status | Progress |
|---|---|---|
| Library Clusters | ✅ Complete | 100% |
| Transcoding Removal | ✅ Complete | 100% |
| Video Player | ✅ Complete | 100% |
| Folder Bookmarks | ✅ Complete | 100% |
| Surprise Me (MVP) | ⚠️ Partial | 43% |
| Recommendation ML | 📋 Planned | 0% |
🛠️ Technical Stack
- Frontend: Next.js 15.5.0, React 19.1.0, TypeScript
- Styling: TailwindCSS v3.4.17
- Database: SQLite with better-sqlite3
- Video Player: ArtPlayer with HLS.js support
- Media Processing: FFmpeg for thumbnails
- Deployment: Docker with multi-stage builds
📖 Core Requirements ✅
All original requirements from project specification are implemented:
- ✅ YouTube-like UI with collapsible sidebar
- ✅ Media library management with scanning
- ✅ Support for 10,000+ media files
- ✅ Photo and video support
- ✅ Library add/remove functionality
- ✅ SQLite database with proper schema
- ✅ Thumbnail generation with hashed storage
- ✅ Bookmark system for videos
- ✅ 1-5 star rating system
- ✅ Text file viewer
- ✅ Docker deployment
🔗 Useful Links
- CLAUDE.md - Project requirements and specifications
- package.json - Dependencies and scripts
- docker-compose.yml - Deployment configuration
Last Updated: October 13, 2025
Next Review: October 20, 2025