Reference vs implementation
Purpose
Section titled “Purpose”The commercial Software Delivery & Handover Document (v1.0) may describe a reference architecture (e.g. Cloudflare Workers, Zuplo, D1, JWT gateway). The shipped product in this repository is a Frappe / ERPNext custom app with MariaDB, Desk UI, and Frappe’s API model.
This page prevents confusion when comparing Word/PDF appendices to the repo.
Summary comparison
Section titled “Summary comparison”| Topic | Reference template (generic) | This repository |
|---|---|---|
| Runtime | Cloudflare Workers, Hono | Frappe / ERPNext (Python, WSGI/ASGI per deployment) |
| API | REST /api/... + gateway JWT | Frappe: @frappe.whitelist, session/API key auth |
| Database | D1 / PostgreSQL (as stated in template) | MariaDB (typical Frappe stack) — confirm version on your site |
| Frontend | Next.js / Ant Design (template) | Desk + bundled JS in public/, Highcharts (see hooks.py) |
| Modules | MOD-01 … MOD-10 generic ERP | Lee Kim Alliance ERP, payroll, Singpass, incorporate, time tracking, etc. |
Documentation rule
Section titled “Documentation rule”Use the PDF as a checklist (architecture, security, deliverables). Populate each section from this codebase, not from the reference stack. Where the template assumes a component you do not use, state N/A and point to the real component (e.g. Frappe ORM instead of raw D1).
Mermaid — documentation alignment
Section titled “Mermaid — documentation alignment”flowchart LR PDF[Commercial handover PDF] REPO[leekimerp repository] DOCS[This Starlight site] PDF -->|structure & checklist| DOCS REPO -->|ground truth| DOCS