Skip to content

index.md

Latest commit

 

History

History
62 lines (49 loc) · 1.43 KB

index.md

File metadata and controls

62 lines (49 loc) · 1.43 KB

System Architecture Overview

This document provides a high-level overview of the architecture for AlexJSully's Portfolio project. The system is modular, maintainable, and leverages modern web technologies for performance and scalability.

🏗️ Architectural Patterns

  • Framework: Next.js (React)
  • Language: TypeScript
  • UI: Material-UI (MUI)
  • Testing: Cypress (E2E), Jest (unit)
  • Error Tracking: Sentry
  • Backend/Data: Firebase
  • PWA Support: next-pwa

📂 Directory Structure

src/
  app/
    components/
    configs/
    data/
    helpers/
    images/
    layouts/
    styles/
    util/
public/
  images/
  resume/
  icon/

🔄 System Flow

flowchart TD
    User -->|HTTP| NextJS_App
    NextJS_App -->|SSR/SSG| React_Components
    React_Components -->|UI| MUI
    NextJS_App -->|API| Firebase
    NextJS_App -->|Error| Sentry
    NextJS_App -->|Service Worker| PWA
Loading

🧩 Subsystems

  • Components: UI elements (see Components Docs)
  • Data: Static and dynamic data sources
  • Helpers/Utils: Utility functions for logic and formatting
  • Layouts: Page and section layouts
  • Testing: E2E and unit tests
  • Config: Environment and service configuration

🔗 Related Docs

💡 Tip: See subsystem docs for detailed breakdowns and diagrams.