Skip to content

Home

Jump to bottom
Josh McLain edited this page Jun 20, 2025 · 5 revisions

Mystical Realms – Wiki Home

Welcome to the Mystical Realms documentation! This wiki is your guide to the architecture, design, development, and best practices for building and contributing to the Mystical Realms Tarot & Astrology platform.

Below you'll find a summary and table of contents for all major documentation pages.

📚 Table of Contents

  1. Tech Stack & Roadmap

    • Overview of the frontend, backend, database, and deployment stack.
    • High-level architecture diagram with Mermaid diagrams.
    • Sprint-by-sprint implementation roadmap for the MVP.
    • Deployment strategy and monitoring considerations.

  2. Sprint Summary

    • Step-by-step breakdown of each sprint (8 sprints total).
    • Granular tasks for systematically building the MVP.
    • Foundation → Auth → Core Features → Polish progression.
    • Guidance for team planning and progress tracking.

  3. Complete Database Schema

    • Enhanced: Comprehensive Supabase PostgreSQL schema documentation.
    • 19 core tables with relationships, constraints, and indexing.
    • Row Level Security (RLS) policies and performance optimizations.
    • Advanced usage patterns, maintenance utilities, and health checks.

  4. Database Implementation Summary

    • New: Complete implementation status and validation report.
    • Migration file structure and deployment commands.
    • Production readiness assessment with enterprise-grade features.
    • Usage examples and performance benchmarks.

  5. Database Validation Report

    • New: Schema completeness and quality analysis.
    • Security implementation verification.
    • Performance optimization validation.
    • Future enhancement recommendations.

  6. Architecture & House Rules

    • Modular, layered, API-first architecture guidelines.
    • Frontend (Next.js) and backend (Python) folder structure.
    • Code organization, testing, and security best practices.
    • Layer responsibilities and design patterns.

  7. Design Principles

    • Visual design principles for a mystical, immersive UI.
    • Theme palettes, font pairings, and iconography standards.
    • Guidance for consistent, accessible, and engaging visuals.

  8. Testing Setup

    • Comprehensive testing strategy for frontend and backend.
    • Jest, Playwright, and Pytest configurations.
    • Unit, integration, and E2E testing approaches.
    • 4-phase testing roadmap implementation.

  9. MDX Content Templates

    • New: Content architecture with MDX and Contentlayer.
    • Blog, knowledge base, and tutorial template structures.
    • SEO optimization and performance considerations.
    • Content management workflow and editorial process.

  10. Sitemap & User Flows

    • New: Complete site architecture and navigation patterns.
    • Public and authenticated user journey flows.
    • SEO metadata configuration and analytics tracking.
    • Critical user experience pathways.

🧭 Getting Started

🔗 Additional Resources

Security & Compliance

Project Management

Architecture Documentation

✨ Contributing

Please read the House Rules and Testing Setup before submitting changes. Our architecture emphasizes:

  • Modularity: Feature-first organization with clear separation of concerns
  • Type Safety: Strict TypeScript and Pydantic model enforcement
  • Test-Driven Development: Comprehensive test coverage across all layers
  • Documentation: Living documentation that evolves with the codebase
  • Security: Enterprise-grade security practices and RLS policies

Consistency and modularity are key to maintaining this complex, feature-rich platform!

Clone this wiki locally