Technical Documentation
Global Watch Technical Documentation
Welcome to the Global Watch Technical Documentation. This section contains comprehensive developer-facing guides and references for contributing to the Global Watch platform.
Overview
Global Watch is built using modern technologies and follows industry best practices for scalable, maintainable software development. This documentation covers everything you need to know to understand, develop, and contribute to the codebase.
Technology Stack
Global Watch is built with:
- Framework: Next.js 16 with App Router and Turbopack
- Runtime: React 19, TypeScript 5.9+
- Database: Supabase (PostgreSQL with Row Level Security)
- Styling: Tailwind CSS 4, Shadcn UI
- Monorepo: Turborepo with pnpm workspaces
- Architecture: Hexagonal (Ports & Adapters)
Documentation Sections
Architecture
Deep dive into the system architecture and design patterns:
- Hexagonal Architecture - Ports & Adapters pattern for clean separation of concerns
- Multi-Tenancy - Subdomain-based routing and tenant isolation
- Database Design - Schema organization, RLS policies, and migrations
- Domain Entities - Rich domain models with encapsulated business logic
Development
Everything you need to set up your development environment:
- Setup Guide - Local development environment configuration
- Conventions - Coding standards and best practices
- Environment Variables - Configuration management
- Package Structure - Understanding @kit vs @fw packages
Testing
Comprehensive testing strategies and guidelines:
- Unit Testing - Vitest configuration and patterns
- Property-Based Testing - Using fast-check for robust testing
- E2E Testing - Playwright setup and test patterns
- Test Coverage - Coverage requirements and reporting
Use Cases
Real-world scenarios and implementation examples:
- Feature Implementation - Step-by-step feature development guides
- Integration Patterns - Common integration scenarios
- Best Practices - Lessons learned and recommendations
Sprints
Historical archive of development sprints:
- Sprint History - Past sprint documentation and decisions
- Feature Evolution - How features evolved over time
- Technical Debt - Known issues and improvement plans
Getting Started
New to Global Watch development? Here's how to get started:
- Clone the repository and install dependencies with
pnpm install - Set up local Supabase with
pnpm supabase:web:start - Start the development server with
pnpm dev - Read the Architecture docs to understand the codebase structure
Contributing
We welcome contributions! Before submitting code:
- Read the Development Conventions documentation
- Follow the RITO Methodology for feature development
- Ensure all tests pass before submitting PRs
- Include documentation for new features
Related Resources
- Platform Documentation - User-facing guides at /docs
- Makerkit Docs - Base framework documentation at makerkit.dev
- GitHub Repository - Source code and issue tracking