Wippidu Kita App - Technical Documentation

Welcome to the technical documentation for the Wippidu Kita App — a daycare management platform built with Go, Gin, and GORM.

This documentation is organized following the Diataxis framework:

Tutorials

Step-by-step lessons for newcomers to get productive with the codebase.

• Getting Started — Set up your development environment and run the app
• Building Your First Feature — End-to-end walkthrough of adding a new feature

How-to Guides

Practical recipes for accomplishing specific tasks.

• Run Tests — Execute the test suite, generate coverage reports
• Write Tests — Test conventions, helpers, patterns
• Add an API Endpoint — Implement a new dual HTML/JSON endpoint
• Run OFT Trace — Generate requirement tracing reports
• Sync Intranet Data — Push and process external data
• Deploy a PR — PR auto-deployment workflow

Reference

Technical specifications and lookup tables.

• API Response Formats — JSON structures, error codes, content negotiation
• Intranet Sync API — Endpoints, staging tables, security
• Database Schema (Current) — PlantUML ER diagram
• Database Schema (Original) — Historical schema
• Design Specifications — Backend design specs (OFT tagged)
• GUI Design Specifications — GUI design specs (OFT tagged)
• UI Specification — UI/UX design guidelines
• Test Accounts (DE) — All test user credentials
• Test Coverage — Current test statistics
• Requirements:
  • High-level Requirements
  • Functional Requirements
  • GUI Requirements
  • OFT Report
  • OFT Status

Explanation

Background knowledge and architectural decisions.

• Architecture Overview — Tech stack, patterns, feature inventory
• Intranet Sync Design — Two-phase sync architecture rationale
• CI/CD Pipeline (DE) — Build, deploy, branch automation
• Authorization Model — Roles, access control, delegation
• OFT Requirement Tracing — How the tracing chain works
• Project History — Historical analysis from Oct 2025