How cryptee/web-client works
Main Components
A. Client-Side (Frontend) Layer
• Document Editor Component
• Photo Storage Component
• Authentication Component
• Encryption Layer (OpenPGP.js implementation)
• File Processing Adapters (PDF.js, EPUB Reader, Mammoth)
• Local Storage/IndexedDB (Dexie implementation)
B. API Gateway Layer
• Authentication Endpoints
• Document Management Endpoints
• Photo Management Endpoints
• Payment/Billing Endpoints
• User Management Service
• Storage Service
• Payment Processing Service
• Abuse Prevention System
Key Relationships to Highlight
a. Client-Side Security:
• Encryption happening entirely in the browser
• Demonstrate how data never leaves the device unencrypted
• Relationship between the encryption layer and storage
b. Adapter Integration:
• How different file format adapters (PDF.js, EPUB, etc.) connect to the main application
• Document processing pipeline
c. Storage Flow:
• Demonstrate the path from local storage to encrypted cloud storage
• Sync mechanisms between devices
Important Architectural Patterns to Emphasize
• Client-Side Encryption: Show how all encryption happens in the browser
• Progressive Web App Structure: Indicate offline capabilities
• Modular Design: Highlight the separation between documents, photos, and authentication
• Multi-Format Support: Show the adapter pattern for different file types
Technical Stack Indicators
Technology badges or labels for:
• Frontend: Zepto/jQuery, QuillJS
• Encryption: OpenPGP.js
• Storage: IndexedDB/Dexie
• File Processing: PDF.js, Mammoth, EPUB Reader
• Authentication: Custom implementation
Security Boundaries
Clearly mark:
• Trust boundaries between client and server
• Encryption/decryption boundaries
• Data storage boundaries
• Authentication checkpoints
Additional Elements
• Version information for critical components
• Points where data is encrypted/decrypted
• Offline capability mechanisms
• Where user preferences and settings are stored