Welcome to the Frontend Docs
Everything a Flutter developer needs to work on the eKYC 3.0 client app.
Sections
Getting Started
Prerequisites, clone, pub get, first run on web / Android / iOS. Troubleshooting.
Mock Mode
Backend-driven mock setup, fixed OTP 1234, what bypasses what, troubleshooting.
Project Tour
Folder structure, pubspec.yaml, what lives in lib/, assets inventory.
Architecture
4-layer architecture, data flow, dependency rules. Links to full SVG diagrams.
Coding Patterns
8 deliberate patterns used throughout: repository, singleton, state machine, wrappers, and more.
Stage Walkthrough
Trace Stage 1 Registration end-to-end: widget → service → backend → storage → next screen.
ApiService
Single-file API client. Headers, auth, _post helper, error handling, how to add a method.
Widgets Reference
5 wrapper widgets: LoadingOverlay, SessionTimer, BackButtonHandler, JourneyProgressBar, ErrorDialog.
Config & Environments
ApiConfig, --dart-define flag, dev/uat/prod builds per platform, isDev guards.
Debugging
DevTools, breakpoints, logs, network inspection, common issues checklists.
How-To Guides
Recipes: add a stage, add an API, add a model, add a widget, add an environment.
Code Notes
This code was AI-generated. What that means, where logic lives, things to watch out for.
FAQ & Glossary
Common questions answered + glossary of eKYC domain terms (KRA, DigiLocker, STP, etc.).
Sonar Analysis
very_good_analysis setup, SARIF export, HTML report via sarif-tools, auto-fixer scripts.
Master Dev Help
One-page lookup: "I want to change X — which file do I open?" Covers screens, widgets, services, config, build.
Android Troubleshooting
Every Windows-specific Gradle/Kotlin/NDK/emulator issue we hit while building the app, with the exact error, root cause, and fix.
Related Documents
- Frontend Architecture - full component and sequence diagrams (SVG)
- Old vs New UI Comparison - stage-by-stage functional differences
- Backend Docs - placeholder (coming soon)