CepatEdge Documentation
Enterprise-Grade Platform - High-performance, cost-optimized maintenance management system with aggressive caching, enterprise security, and edge-first architecture.
This directory is the single source of truth for all CepatEdge documentation.
Repository-root planning docs (/system/* and admin analytics)
These two files live at the monorepo root (not under docs/). They are the canonical plans for the admin system area; keep them updated as you implement.
maintainer/phases/system-observability.md— Observability for/system/*(internal logs, audit, monitor, settings). Finish this plan first when working through system hardening.maintainer/phases/dashboard.md— Dashboard and analytics. Start after system observability is in a good state.
Contributors: see maintainer/temp/CONTINUE.md and maintainer/phases/active-phase.md. Maintainer plans are not synced to the public docs site.
Structure
journey/- First-person story of how this project started (README.md)architecture/- Architecture decisions, principles, and system designssystem-map.md- System map and infrastructure diagram (single reference)principles.md- Core architectural principlesdecisions/- Architecture Decision Records (ADRs)systems/- Core system documentationruntime/- Edge runtime specifics
lifecycle/- Locked domain behavior: maintenance workflows, status transitions, permissions,finalSnapshot, cache contracts (lifecycle/README.md)guides/- User and developer guidesdomains.md- Production URLs, Pages projects, cookiesrunbook.md- Incidents, recovery, backups (including R2 backup plan)getting-started.md- Quick start guidedeployment.md- Deployment guideapi/- API documentationconfiguration/- Configuration guides
strategy/- Strategic planning and vision documentsvision.md- Long-term visionroadmap.md- Product roadmaphandover-and-positioning.md- Generic handover and presentation framing
institutional-readiness/- Institutional hardening layer: gap assessment and hardening plan for university/enterprise IT, security, and governance reviews.README.md- Purpose of the institutional readiness docs and how to use thempilot-readiness-gap-assessment.md- Where CepatEdge stands vs typical university requirementshardening-sprint-plan.md- 4–8 week institutional hardening sprint plan
university/- Isolated: All documentation specific to handing over to one target institution (e.g. a specific university). Delete this folder when re-branching for another client; the rest of the docs stay client-agnostic.handover/- What we hand over, checklist, commitmentour-planning/- Our strategy, positioning, files to remove/leave when they take overfor-institution/- Docs for the institution (training, admin, support)
workflows/- Development workflows and processesdevelopment.md- Development workflowdeployment.md- Deployment workflowbackend-migration-audit.md- Next.js → Workers backend migration status and completion %
todo/- Planned work and technical debt trackingfeatures.md- Planned featuresimprovements.md- Improvement ideastechnical-debt.md- Technical debt
security/- Security documentation and advisoriesoverview.md- Security overviewdata-retention-and-privacy.md- Data retention and privacy/compliance (institutional review)
frontend/- Frontend architecture, context model, API/Axios patterns, permissions, and TanStack Query adoption planai-agents/- Playbooks for automated coding agents: Git workflow, commit style, and codebase patterns (seeai-agents/README.md)
Architecture Overview
CepatEdge is an enterprise-grade maintenance management platform built with modern edge computing technologies, delivering exceptional performance, security, and cost efficiency for organizations of any size.
Core Advantages
- ⚡ Speed Aggressive Caching: Multi-layer caching strategy reducing database calls by 80-90%
- 🔒 Enterprise Security: JWT authentication, role-based access control, comprehensive audit logging
- 💰 Cost Efficient: Optimized to stay under probably nothing even with university-scale usage
- 🌐 Edge-First Architecture: Global performance with <100ms response times worldwide
- 📈 Auto-Scaling: Horizontal scaling across 300+ data centers without configuration
- 🔧 Developer Experience: TypeScript-first, comprehensive testing, clean architecture
Technology Stack
- Frontend: React SPA on Cloudflare Pages (dynamic routing without server overhead)
- Backend: Hono API on Cloudflare Workers (lightweight, fast, edge-native)
- Database: Neon Serverless PostgreSQL with Drizzle ORM (connection pooling, query optimization)
- Caching: Single Durable Object class with multiple instances, optimized for faster reads when cache hits thanks to timestamp and index-based instances of DO
- Deployment: Zero-configuration deployment with Cloudflare's global network
Quick Links
- System observability plan (
maintainer/phases/) - Dashboard plan (
maintainer/phases/) - Active phase checklist · CONTINUE.md
- Architectural Principles
- Getting Started Guide
- API Reference
- Deployment Guide
- Why This Exists
- Journey — how this project was born (first person)
- ADR-001: Single Durable Object Class
- ADR-002: Edge-First Architecture
- ADR-003: Cost Optimization Strategy
- ADR-004: React SPA on Cloudflare Pages
- ADR-005: Durable Objects for State Management
- ADR-006: Hono Framework for Edge API
- ADR-007: Neon + Drizzle for Database Layer
- ADR-008: Cloudflare R2 for File Storage
- ADR-009: Shared Feature Pages for Cross-Role Workflows
- ADR-010: Frontend Context Boundaries (App State Only)
- ADR-011: TanStack Query for Frontend Server State
Enterprise Advantages
Performance Excellence
- Sub-100ms Global Response Times: Edge deployment ensures consistent performance worldwide
- 80-90% Database Call Reduction: Aggressive caching with Durable Objects minimizes backend load
- Automatic Scaling: Handles traffic spikes across 300+ global data centers
- Zero Cold Starts: Persistent Durable Objects maintain state between requests
- Global File Delivery: R2 storage with Cloudflare CDN for instant file access
Cost Efficiency
- Free Tier Maximized: 100K Workers requests/day, 1GB Neon storage, unlimited Pages hosting
- Predictable Scaling: Linear cost growth with usage, transparent pricing
- No Hidden Fees: All services included, no premium feature locks
- Cost Efficient: Almost costs nothing unless real heavy usage like more than 50K-100K requests per day
- Scales to Millions: Will still cost nothing even if usage hits millions thanks to advanced caching, R2 usage for uploads, and Neon serverless DB with minimal DB calls
Enterprise Security
- JWT-Based Authentication: Stateless, secure session management
- Role-Based Access Control: Granular permissions for different user types
- Comprehensive Audit Logging: Complete activity tracking and monitoring
- Input Validation: Type-safe APIs with runtime validation
Development
Prerequisites
- Node.js 18+
- pnpm
- Cloudflare account
Quick Start
bash
# Install dependencies
pnpm install
# Start development servers
cd apps/worker && pnpm wrangler dev
cd apps/web && pnpm devTesting
bash
# Run all tests
pnpm test
# Run specific app tests
cd apps/worker && pnpm testContributing
- Edit documentation in this
docs/directory - Documentation is auto-synced to
apps/docs/for the website - Follow the established patterns and structure
- Add ADRs for significant architectural decisions