Welcome to the Frontend Docs

Everything a Flutter developer needs to work on the eKYC 3.0 client app.

💡 First time? Read pages 010203 in order. That's the fastest path from zero to running the app locally.

Sections

01

Getting Started

Prerequisites, clone, pub get, first run on web / Android / iOS. Troubleshooting.

02

Mock Mode

Backend-driven mock setup, fixed OTP 1234, what bypasses what, troubleshooting.

03

Project Tour

Folder structure, pubspec.yaml, what lives in lib/, assets inventory.

04

Architecture

4-layer architecture, data flow, dependency rules. Links to full SVG diagrams.

05

Coding Patterns

8 deliberate patterns used throughout: repository, singleton, state machine, wrappers, and more.

06

Stage Walkthrough

Trace Stage 1 Registration end-to-end: widget → service → backend → storage → next screen.

07

ApiService

Single-file API client. Headers, auth, _post helper, error handling, how to add a method.

08

Widgets Reference

5 wrapper widgets: LoadingOverlay, SessionTimer, BackButtonHandler, JourneyProgressBar, ErrorDialog.

09

Config & Environments

ApiConfig, --dart-define flag, dev/uat/prod builds per platform, isDev guards.

10

Debugging

DevTools, breakpoints, logs, network inspection, common issues checklists.

11

How-To Guides

Recipes: add a stage, add an API, add a model, add a widget, add an environment.

12

Code Notes

This code was AI-generated. What that means, where logic lives, things to watch out for.

13

FAQ & Glossary

Common questions answered + glossary of eKYC domain terms (KRA, DigiLocker, STP, etc.).

14

Sonar Analysis

very_good_analysis setup, SARIF export, HTML report via sarif-tools, auto-fixer scripts.

15

Master Dev Help

One-page lookup: "I want to change X — which file do I open?" Covers screens, widgets, services, config, build.

16

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