EduLift Documentation

📋 Main Documentation

Core Documents

These documents contain the complete, up-to-date information about EduLift:

1. Technical Documentation - Complete technical architecture, implementation details, and development guidelines
2. API Documentation - Comprehensive API reference with endpoints, authentication, and examples
3. Functional Documentation - Business logic, user workflows, and feature specifications
4. Deployment Documentation - Setup, deployment, and production management guides

🔗 Deep Link System (New!)

EduLift features an advanced deep link system with environment-aware URL generation:

5. Deep Link Architecture - Complete system architecture comparison (old vs new)
6. Deep Link Configuration Guide - Environment setup and configuration
7. Deep Link Examples - Real-world examples and use cases
8. Deep Link Development Guide - Local development and best practices
9. Deep Link Troubleshooting - Common issues and solutions

🏗️ Architecture Overview

EduLift implements a dual-system architecture:

• Family System: Resource ownership (children, vehicles) within family units
• Group System: Scheduling coordination across multiple families for transportation planning

🚀 Quick Start

For New Developers

1. Development Setup: See Deployment Documentation
2. Deep Link System: Read Deep Link Architecture for the new URL system
3. API Integration: Start with API Documentation
4. Business Logic: Understand workflows in Functional Documentation

For Deep Link Implementation

1. Understand Architecture: Deep Link Architecture - old vs new system
2. Configure Environment: Deep Link Configuration Guide
3. Review Examples: Deep Link Examples for real-world usage
4. Local Development: Deep Link Development Guide

📊 Current Implementation Status

• ✅ Backend Coverage: 100% test coverage achieved
• ✅ Frontend Coverage: 83%+ with ongoing data-testid selector conversion (62% complete)
• ✅ Family System: Fully implemented with family-based group ownership
• ✅ Real-time Features: Socket.IO implementation with conflict detection
• ✅ Deep Link System: New URL generation system with three-tier fallback implemented
• 🔄 Role System: ADMIN/MEMBER roles (PARENT role deprecated)
• 🔄 Caching: Redis infrastructure ready, application integration pending

🛠️ Development Guidelines

Testing Strategy

• TDD Approach: Red-Green-Refactor cycle for all new features
• Test Pyramid: Unit tests (Jest/Vitest) → Integration tests → E2E tests (Playwright)
• Selector Strategy: Use data-testid attributes for reliable test selectors

Code Standards

• TypeScript: Strict type checking throughout
• API Design: RESTful endpoints with Zod validation
• Real-time: Socket.IO for collaborative features
• Database: PostgreSQL with Prisma ORM

📁 Documentation Structure

docs/
├── README.md                           # This overview document
├── Technical-Documentation.md          # Complete technical guide
├── API-Documentation.md               # API reference
├── Functional-Documentation.md        # Business logic & workflows
├── Deployment-Documentation.md        # Setup & deployment
├── deep-link-architecture.md          # Deep link system architecture
├── deep-link-configuration-guide.md   # Environment configuration
├── deep-link-examples.md              # Real-world examples
├── deep-link-development-guide.md     # Development & best practices
├── deep-link-troubleshooting-guide.md # Common issues & solutions
├── deep-link-configuration-override-guide.md # Manual overrides
├── references/                        # Supplementary reference materials
│   ├── README.md
│   ├── Architecture-Family-vs-Groups.md
│   ├── Access-Control-and-Permissions.md
│   ├── Testing-Strategy.md
│   └── Family-Management-Accessibility-Guide.md
└── archive/                           # Historical documentation
    ├── README.md
    ├── specifications/
    └── outdated/

📞 Support

• Issues: Report bugs and feature requests via GitHub issues
• Development: Follow the contribution guidelines in Technical Documentation
• API Questions: Refer to API Documentation examples and troubleshooting sections
• Deep Dives: Check references/ for detailed implementation guides

---

This documentation is maintained to reflect the current implementation and is updated with each release.