How bigxingyun/yuyue-novel-platform works
欲阅 is a multi-user short-fiction reading and publishing platform. Readers browse books, read chapters, manage a shelf and history, and comment; users register or recover access, authors apply for approval and manage works, and administrators govern users and content. The Vue client calls a FastAPI API, whose domain services use SQLAlchemy-backed SQLite. The README documents reader settings, progress sync, device adaptation, and operational features; some associated source was not sampled, so those links are shown only where documented, and unsampled service relationships are omitted.
Main entry points: router.py API router · ReaderView.vue Reading experience · request.ts API client · models Domain models
Components 24
Vue client
- Vue application
frontend/src/main.ts - Browse books
frontend/src/views/square/SquareView.vue - Reading experience
frontend/src/views/reader/ReaderView.vue - Author workspace
frontend/src/views/profile/WorksManageView.vue - Admin console
frontend/src/views/admin/ApplicationReviewView.vue - API client
frontend/src/api/request.ts
Identity and profiles
- API router
backend/app/api/v1/router.py - Auth endpoints
backend/app/api/v1/auth.py - Authentication
backend/app/services/auth_service.py - User and profile routes
backend/app/api/v1/profile.py - Profiles and experience
backend/app/services/profile_service.py
Reading and creation
- Book routes
backend/app/api/v1/books.py - Book catalog
backend/app/services/book_service.py - Chapter and reading routes
backend/app/api/v1/reading.py - Author routes
backend/app/api/v1/author.py - Work and chapter editing
backend/app/services/author_service.py - Image uploads
backend/app/services/upload_service.py
Community and governance
- Comment routes
backend/app/api/v1/comments.py - Comment management
backend/app/services/comment_service.py - Admin routes
backend/app/api/v1/admin - Platform governance
backend/app/services/admin_service.py
Persistence
- Domain models
backend/app/models - SQLite database
backend/app/database.py
Other components
- Reader
Connections 28
- Reader → Vue application: uses
README.md - Vue application → Browse books: routes to
README.md - Vue application → Reading experience: routes to
README.md - Vue application → API client: calls
- Browse books → API client: requests books
- Reading experience → API client: requests chapters
- Author workspace → API client: submits work
- Admin console → API client: governs content
- API client → API router: HTTP requests
README.md - API router → Auth endpoints: dispatches
backend/app/api/v1/router.py - API router → Book routes: dispatches
backend/app/api/v1/router.py - API router → Chapter and reading routes: dispatches
backend/app/api/v1/router.py - API router → Author routes: dispatches
backend/app/api/v1/router.py - API router → Comment routes: dispatches
backend/app/api/v1/router.py - API router → Admin routes: dispatches
backend/app/api/v1/router.py - Auth endpoints → Authentication: calls
backend/app/api/v1/auth.py - User and profile routes → Profiles and experience: calls
- Book routes → Book catalog: calls
backend/app/api/v1/books.py - Author routes → Work and chapter editing: calls
backend/app/api/v1/author.py - Comment routes → Comment management: calls
- Admin routes → Platform governance: reviews applications
backend/app/api/v1/admin/applications.py - Work and chapter editing → Domain models: reads and writes
backend/app/services/author_service.py - Authentication → Domain models: reads and writes
backend/app/services/auth_service.py - Comment management → Domain models: reads and writes
backend/app/services/comment_service.py - Platform governance → Domain models: reads and writes
backend/app/services/admin_service.py - SQLite database → Domain models: maps models
- Reading experience → Reading experience: syncs settings
README.md - Reading experience → Reading experience: saves progress
README.md