How rr-/szurubooru works
Main Components
a. Client-Side (Frontend):
• Single Page Application (SPA) built with JavaScript
• MVC architecture with:
• Controllers (client/js/controllers/)
• Models (client/js/models/)
• Views (client/js/views/)
• Static assets (CSS, HTML templates, images)
b. Server-Side (Backend):
• REST API (server/szurubooru/api/)
• Database layer (server/szurubooru/model/)
• Search system (server/szurubooru/search/)
• File storage system
• Authentication system
c. External Services:
• yt-dlp integration for web video content
• Email service (for password reset)
• Client Layer | | Server Layer | | Storage Layer |
Component Relationships
• Client → Server: REST API calls
• Server → Database: Data persistence
• Server → File Storage: Media storage
• Server → External Services: Video fetching, email
Detailed Components
Client Layer:
• Client Layer |
• Views | |
• Controllers | |
• Models | |
• Router | |
Server Layer:
• Server Layer |
• REST API | |
• Authentication| |
• Search System | |
• Business Logic | |
Important Features to Highlight
Create subsections showing:
• Post management system
• Tag system with implications and aliases
• Pool management
• User privilege system
• Search functionality
• Media processing pipeline
Additional Elements
Include:
• Version information
• Database schema overview
• API endpoints summary
• Security boundaries
Technical Details to Note
• Nginx serving static files
• SQLAlchemy ORM
• Alembic migrations
• Docker containerization
• Token-based authentication
• REST API architecture
Remember to maintain a balance between detail and clarity, focusing on the architectural decisions that make szurubooru unique, such as its tag system, search capabilities, and media handling features.