Documentation
Complete guides and references for Mkutano's features, architecture, and deployment.
Full Documentation
Print-ready HTML version
Complete 50+ page guide covering architecture, features, user roles, data model, deployment, and troubleshooting. Optimized for printing to PDF.
View HTMLMarkdown Version
Source format for developers
Same comprehensive documentation in Markdown format. Best for version control, editing, and converting to other formats like PDF or EPUB.
Download MDDocumentation Sections
Application Overview
What Mkutano does, core mission, and key statistics
Core Features
Public marketing site, community dashboard, enterprise edition, offline capabilities
System Architecture
High-level architecture, data flow, security layers
Technology Stack
Frontend (Next.js, React, TypeScript), backend (Supabase), PWA, deployment
User Roles & Permissions
5 roles (Secretary, Member, NGO, MFI, Admin) with detailed access control
Data Model
12 database tables, relationships, RLS security policies
Application Structure
Complete directory layout and file organization
Key Features by Module
Detailed breakdown of each dashboard page and functionality
Enterprise Edition
NGO platform, MFI platform, funding flows, impact tracking
Authentication & Security
Phone/email auth, RLS policies, audit trails, encryption
Offline-First & PWA
Service workers, caching strategies, demo mode, sync manager
Getting Started
Installation, development server, production build, Vercel deployment
Demo Accounts
5 pre-configured test accounts for community and enterprise platforms
API & Integration
Supabase integration, database queries, authentication methods
Deployment & Versioning
Current version, build output, browser support, recent changes
How to Generate PDF
- 1.Open HTML documentation: Click "View HTML" above or visit
/docs/MKUTANO_DOCUMENTATION.html - 2.Print to PDF: Press
Ctrl+P(Windows) orCmd+P(Mac) - 3.Select printer: Choose "Save as PDF" from the printer dropdown
- 4.Save: Click "Save" to generate your professional PDF documentation
✓ All formatting preserved • ✓ Proper page breaks • ✓ Color-coded sections • ✓ Professional styling
Quick Reference
Key Statistics
- 📄 33 Routes in production
- 👥 5 User Roles with different dashboards
- 📊 8+ Dashboard Modules
- 📱 100% PWA installable
- 🔒 Row-Level Security for data isolation
Tech Stack
- Frontend: Next.js 14, React, TypeScript
- Styling: Tailwind CSS
- Backend: Supabase (PostgreSQL)
- Auth: Phone OTP + Email
- Deployment: Vercel (auto)
Demo Accounts
- 📞 Secretary: +254700000001
- 👤 Member: +254700000003
- 🏢 NGO: Maendeleo Foundation
- 🏦 MFI: Ulinzi MFI for MSMEs
- ✋ No password required