How illyadd/pdf-share works
PDF+ is a Django monolith for managing, reading, and sharing PDF books in a learning setting. A user enters through account access, then browses a personal/shared/catalog library; upload forms validate PDFs before saving, and access rules determine which books are visible. The reader renders PDFs in-browser and stores per-user highlights and notes. Separate sharing workflows grant class or token-link access, while the JWT REST API supports catalog/file access and offline delta sync. Edges reflect README statements and source references; unsampled routes and templates limit detail on their exact dispatch and rendering connections.
Main entry points: sync.py Delta sync · models.py Books and folders · book_library/views.py Library browsing · users/views.py Account access
Components 21
Accounts
- Account access
PDF+/users/views.py - User accounts
PDF+/users/models.py
PDF library
- Library browsing
PDF+/book_library/views.py - Books and folders
PDF+/book_library/models.py - Upload forms
PDF+/book_library/forms.py - PDF inspection
PDF+/book_library/pdf.py - Visibility rules
PDF+/book_library/access.py - PDF storage
PDF+/book_library/signals.py
Sharing
- Sharing management
PDF+/sharing/views.py - Sharing forms
PDF+/sharing/forms.py - Groups and links
PDF+/sharing/models.py
Reader and annotations
- Browser reader
PDF+/static/js/reader.js - Annotation JSON API
PDF+/annotations/api.py - Payload validation
PDF+/annotations/validators.py - User annotation layers
PDF+/annotations/models.py
Offline API
- JWT REST endpoints
PDF+/api/views.py - Delta sync
PDF+/api/sync.py - Deleted annotation markers
PDF+/api/models.py
Other components
- User
- Mobile/offline client
- Google OAuth
Connections 26
- User → Account access: uses
PDF+/users/views.py - Account access → User accounts: authenticates
PDF+/users/views.py - Account access → Google OAuth: signs in via
PDF+/users/views.py - User → Library browsing: browses
- Library browsing → Visibility rules: filters by visibility
PDF+/book_library/views.py - Library browsing → Books and folders: reads and manages
PDF+/book_library/views.py - Library browsing → Upload forms: validates upload
PDF+/book_library/views.py - Upload forms → PDF inspection: inspects PDF
PDF+/book_library/forms.py - Upload forms → Books and folders: saves book
PDF+/book_library/views.py - Books and folders → PDF storage: stores and deletes files
PDF+/book_library/signals.py - User → Sharing management: manages access
- Sharing management → Sharing forms: uses forms
PDF+/sharing/views.py - Sharing management → Groups and links: updates sharing records
PDF+/sharing/views.py - Groups and links → Books and folders: targets books and folders
PDF+/sharing/models.py - Visibility rules → Groups and links: checks grants and links
PDF+/book_library/access.py - User → Browser reader: reads books
- Browser reader → Annotation JSON API: sends annotation requests
- Annotation JSON API → Payload validation: validates payload
PDF+/annotations/validators.py - Annotation JSON API → User annotation layers: reads and writes
PDF+/annotations/models.py - Mobile/offline client → JWT REST endpoints: calls REST API
- JWT REST endpoints → Delta sync: dispatches sync
PDF+/api/views.py - Delta sync → Visibility rules: filters visible content
PDF+/api/sync.py - Delta sync → Books and folders: pulls book state
PDF+/api/sync.py - Delta sync → Payload validation: validates changes
PDF+/api/sync.py - Delta sync → User annotation layers: syncs annotations
PDF+/api/sync.py - Delta sync → Deleted annotation markers: tracks deletions
PDF+/api/sync.py