ECall iOS - Documentation¶
Technical and business documentation for ECall iOS application - an end-to-end encrypted (E2EE) video/audio calling application.
📚 Document Structure¶
Technical Documentation (/technical)¶
Detailed technical documentation about architecture, implementation, and application modules.
- Architecture Overview - System architecture overview
- Core Modules - Details of Core modules (Security, Networking, Persistence, Language)
- Call Module - Call module details with WebRTC and E2EE
- Authentication Flow - Unified authentication (sign-in/registration) flow
- API Documentation - API endpoints and integration documentation
- Partner Build Guide - Technical guide for partners to build custom iOS applications
- Configuration Variables - Complete guide for all configurable variables
Business Documentation (/business)¶
Business documentation about requirements, user flows, and features.
- Business Requirements - Business requirements and features
- User Flows - Main user flows (unified authentication, calling, contacts, login methods)
- Features Overview - Features overview
- Partner Setup Guide - Guide for partners/resellers to set up custom applications
🚀 Quick Start¶
- To understand the overview: Read Architecture Overview
- To implement new features: Refer to Core Modules and corresponding module
- To understand business flows: See User Flows
📋 Document Purpose¶
This document is created to: - Onboarding: Help new developers quickly understand the codebase - Reference: Reference documentation when developing new features - Maintenance: Support maintenance and debugging - Architecture Decision: Store important architectural decisions
🔄 Document Updates¶
This document is updated when: - Major architectural changes occur - New features are added - Business flows change - Security/performance improvements are made
📝 Conventions¶
- Code references: Use format
filepath:lineto reference code - Diagrams: Use Mermaid or ASCII art
- Examples: Always include code examples
- Language: English for explanations, English for code/API