# sebastianfdz/jira_clone architecture

> Architecture diagram of the GitHub repository sebastianfdz/jira_clone, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sebastianfdz/jira_clone
- Repository: https://github.com/sebastianfdz/jira_clone

## Overview

##### Project Type and Purpose
- This is a full-stack, single-page application (SPA) clone of Jira, built with Next.js 13’s new app directory.
- It provides user authentication, project/issue/sprint management, and uses React Server Components (RSC) alongside client components.
- Key 3rd-party systems: Clerk (auth), Upstash (rate-limiting/Redis), and a relational database (via Prisma ORM).

##### File Structure
- Top-level “app” directory: Next.js routes (server components, client components, page.tsx).
- “app/api” subtree: REST-style API routes for issues, projects, sprints, and nested resources (comments, members).
- “components” and “ui”: reusable React components (RSC + client UI).
- “server”: database client initialization (server/db.ts) and shared functions.
- “prisma”: schema.prisma and seed scripts—defines DB model and migrations.
- “utils” and “hooks”: client utilities and React-Query hooks for data fetching.
- “middleware.ts”: global middleware for auth or rate-limiting.
- Config files: Clerk, Tailwind, ESLint, Next.js, TypeScript.

##### README for Additional Insights
- Auth lifecycle managed by Clerk.
- Rate limiting via Upstash.
- Data fetching with React-Query (end-to-end type safety with Zod).
- Styling with Radix UI + Tailwind.
- ORM: Prisma + MySQL (or other provider).

##### Main Components & Their Relationships
a. Client Browser (React + Next.js App)
– Renders pages and UI components (app/layout.tsx, components/**).
– Uses React-Query hooks to call internal API routes.
b. Next.js Server
– Handles route rendering (RSC, SSR, client).
– Exposes /api/* endpoints (app/api/**/route.ts).
– Applies middleware for auth & rate limiting.
c. Internal API Layer
– Business logic lives in server/functions.ts and server/db.ts.
– API routes call Prisma client to query/update the relational DB.
d. Database
– MySQL (or chosen provider) via Prisma ORM.
– Seed data via prisma/seed.ts.
e. Third-Party Services
– Clerk: user sign-up, sign-in, session management.
– Upstash Redis: rate limiting on API calls.
f. Client-Side State & Data Fetching
– React Query + Zod for type-safe fetch/mutate.
– Local React state (contexts/hooks) for filters, selected issue, modals.

##### Architectural Patterns & Design Principles
- Component-based UI (Atomic design: ui, form, modals, issue, backlog, board, roadmap).
- Directory-based routing & filesystem API in Next.js 13.
- React Server Components coexisting with client components.
- Single codebase for frontend and backend (monorepo style).
- Clear separation: UI ←→ data fetching hooks ←→ API routes ←→ server logic ←→ DB.

– Callouts for critical cross-cutting concerns (auth, rate limit, type safety).

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Client Layer (Browser UI)"
        Browser["Browser UI\n(Next.js App)"]:::frontend
        Layout["app/layout.tsx"]:::frontend
        AuthPages["app/(auth)"]:::frontend
        ProjectPages["app/project/*"]:::frontend
        Components["components/"]:::frontend
        Styles["styles/globals.css\ntailwind.config.ts"]:::frontend
        Browser --> Layout
        Browser --> AuthPages
        Browser --> ProjectPages
        Browser --> Components
        Browser --> Styles
    end

    subgraph "Client State & Data Fetching"
        Hooks["hooks/query-hooks/"]:::frontend
        Utils["utils/"]:::frontend
        Browser --> Hooks
        Hooks --> Utils
    end

    subgraph "Next.js Server Layer"
        Middleware["middleware.ts"]:::server
        APIIssues["app/api/issues/"]:::server
        APIProjects["app/api/project/"]:::server
        APISprints["app/api/sprints/"]:::server
        Browser -->|"fetchIssues()/fetchProjects()/fetchSprints() via React Query"| APIIssues
        Browser -->|"fetchProjects() via React Query"| APIProjects
        Browser -->|"fetchSprints() via React Query"| APISprints
        APIIssues --> Middleware
        APIProjects --> Middleware
        APISprints --> Middleware
    end

    subgraph "Internal API Layer"
        Functions["server/functions.ts"]:::server
        DBClient["server/db.ts"]:::server
        APIIssues --> Functions
        APIProjects --> Functions
        APISprints --> Functions
        Functions --> DBClient
    end

    subgraph "Database Layer"
        PrismaSchema["prisma/schema.prisma"]:::database
        PrismaSeed["prisma/seed.ts\nprisma/seed-data.ts"]:::database
        DBClient --> PrismaSchema
        DBClient --> PrismaSeed
        PrismaSchema -->|"migrations"| Database["MySQL Database"]:::database
    end

    subgraph "Third-Party Services"
        Clerk["Clerk Auth"]:::external
        Upstash["Upstash Redis\n(rate limiting)"]:::external
        Browser <-->|"auth/session"| Clerk
        Middleware -->|"rateLimit()"| Upstash
    end

    click Layout "https://github.com/sebastianfdz/jira_clone/blob/main/app/layout.tsx"
    click AuthPages "https://github.com/sebastianfdz/jira_clone/tree/main/app/(auth)"
    click ProjectPages "https://github.com/sebastianfdz/jira_clone/tree/main/app/project/*"
    click Components "https://github.com/sebastianfdz/jira_clone/tree/main/components/"
    click Styles "https://github.com/sebastianfdz/jira_clone/blob/main/styles/globals.css"
    click Styles "https://github.com/sebastianfdz/jira_clone/blob/main/tailwind.config.ts"
    click Hooks "https://github.com/sebastianfdz/jira_clone/tree/main/hooks/query-hooks/"
    click Utils "https://github.com/sebastianfdz/jira_clone/tree/main/utils/"
    click Middleware "https://github.com/sebastianfdz/jira_clone/blob/main/middleware.ts"
    click APIIssues "https://github.com/sebastianfdz/jira_clone/blob/main/app/api/issues/route.ts"
    click APIIssues "https://github.com/sebastianfdz/jira_clone/blob/main/app/api/issues/[issueId]/route.ts"
    click APIProjects "https://github.com/sebastianfdz/jira_clone/blob/main/app/api/project/route.ts"
    click APIProjects "https://github.com/sebastianfdz/jira_clone/blob/main/app/api/project/[project_id]/members/route.ts"
    click APISprints "https://github.com/sebastianfdz/jira_clone/blob/main/app/api/sprints/route.ts"
    click APISprints "https://github.com/sebastianfdz/jira_clone/blob/main/app/api/sprints/[sprint_id]/route.ts"
    click Functions "https://github.com/sebastianfdz/jira_clone/blob/main/server/functions.ts"
    click DBClient "https://github.com/sebastianfdz/jira_clone/blob/main/server/db.ts"
    click PrismaSchema "https://github.com/sebastianfdz/jira_clone/blob/main/prisma/schema.prisma"
    click PrismaSeed "https://github.com/sebastianfdz/jira_clone/blob/main/prisma/seed.ts"
    click PrismaSeed "https://github.com/sebastianfdz/jira_clone/blob/main/prisma/seed-data.ts"

    classDef frontend fill:#E3F2FD,stroke:#2196F3,color:#0D47A1
    classDef server fill:#E8F5E9,stroke:#4CAF50,color:#1B5E20
    classDef database fill:#FFF3E0,stroke:#FF9800,color:#E65100
    classDef external fill:#F3E5F5,stroke:#9C27B0,color:#4A148C
```
