# adatechschool/gazette architecture

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

- Interactive diagram: https://gitdiagram.com/adatechschool/gazette
- Repository: https://github.com/adatechschool/gazette

## Overview

##### Project type and purpose
- This is a full-stack TypeScript monorepo ("gazette") containing:
- A NestJS backend (CommonJS) with MikroORM and PostgreSQL
- A Next.js React frontend
- A shared package for cross-cutting DTOs, enums, interfaces, and schemas
- Its purpose is to serve as a content aggregation platform (“Gazette”) with features like RSS feeds, user authentication, content favoriting, and user settings.

##### File structure
- Top-level directories:
- apps/backend – NestJS API
- apps/frontend – Next.js web app
- packages/shared – shared DTOs, enums, interfaces, schemas
- Backend follows a modular MVC-style structure:
- src/modules/{auth,content,favorite,rss,user,roles,jwt}
- Entities under src/entities, migrations under src/migrations, MikroORM configs
- Frontend uses Next.js 13 app-folder with route groups for “(auth)” and “(main)”; custom components, providers, services, hooks, contexts, i18n, theme, utils
- Shared package exports strongly-typed DTOs/enums/interfaces for both ends
- Docker files (Dockerfile, docker-compose.yml) define three services: backend, frontend, database

##### README for additional insights
- Confirms stack: NestJS + MikroORM + Postgres, Next.js
- Shows environment variables, ports, and Docker Compose orchestration
- Mentions migrations, hot-reload considerations, and monorepo layout

##### Details
- Environment orchestration (Docker Compose) is noted, perhaps as a wrapper around the services.
- Use of MikroORM migrations in the backend.
- Call out SSR vs. API calls in the frontend where useful.
- Authentication flows (e.g., login request → auth module → JWT issuance → protected routes guarded by roles).

## Diagram (Mermaid)

```mermaid
flowchart TB
    classDef server fill:#D6EAF8,stroke:#3498DB
    classDef external fill:#F2F3F4,stroke:#95A5A6
    classDef shared fill:#E8F8F5,stroke:#1ABC9C
    classDef db fill:#FCF3CF,stroke:#F1C40F

    Client["Client (Browser)"]:::external
    RSSFeeds["External RSS Feeds"]:::external
    Shared["Shared Package\n(Compile-time TypeScript DTOs)"]:::shared

    subgraph "Docker Compose"
        Orchestration["Docker Compose Orchestration"]:::server

        subgraph "Monorepo Services"
            subgraph "Frontend Service"
                Frontend["Next.js Frontend"]:::server
                subgraph "Frontend Routes"
                    FAuth["Auth Routes"]:::server
                    FMain["Main Routes"]:::server
                end
            end

            subgraph "Backend Service"
                Backend["NestJS Backend API"]:::server
                ORMCfg["MikroORM Config"]:::server
                subgraph "Backend Modules"
                    Auth["Auth Module"]:::server
                    Content["Content Module"]:::server
                    Favorite["Favorite Module"]:::server
                    RSSMod["RSS Module"]:::server
                    Feeds["Feed Implementations"]:::server
                    User["User Module"]:::server
                    Roles["Roles Module"]:::server
                    JWT["JWT Module"]:::server
                    Entities["ORM Entities"]:::server
                    Migrations["Database Migrations"]:::server
                end
            end

            DB["PostgreSQL Database"]:::db

            FrontendDocker["Frontend Dockerfile"]:::server
            BackendDocker["Backend Dockerfile"]:::server
        end
    end

    Client -->|"HTTP/HTTPS"| Frontend
    Frontend -->|"REST API Calls"| Backend
    Backend -->|"ORM Queries"| DB
    Backend -->|"Fetch Feeds (HTTP GET)"| RSSFeeds
    Shared -.-> Frontend
    Shared -.-> Backend

    click Frontend "https://github.com/adatechschool/gazette/tree/main/apps/frontend"
    click Backend "https://github.com/adatechschool/gazette/tree/main/apps/backend"
    click Shared "https://github.com/adatechschool/gazette/tree/main/packages/shared"
    click Orchestration "https://github.com/adatechschool/gazette/blob/main/docker-compose.yml"
    click ORMCfg "https://github.com/adatechschool/gazette/blob/main/apps/backend/src/mikro-orm.config.ts"
    click Auth "https://github.com/adatechschool/gazette/tree/main/apps/backend/src/modules/auth"
    click Content "https://github.com/adatechschool/gazette/tree/main/apps/backend/src/modules/content"
    click Favorite "https://github.com/adatechschool/gazette/tree/main/apps/backend/src/modules/favorite"
    click RSSMod "https://github.com/adatechschool/gazette/tree/main/apps/backend/src/modules/rss"
    click Feeds "https://github.com/adatechschool/gazette/tree/main/apps/backend/src/modules/rss/feeds"
    click User "https://github.com/adatechschool/gazette/tree/main/apps/backend/src/modules/user"
    click Roles "https://github.com/adatechschool/gazette/tree/main/apps/backend/src/modules/roles"
    click JWT "https://github.com/adatechschool/gazette/tree/main/apps/backend/src/modules/jwt"
    click Entities "https://github.com/adatechschool/gazette/tree/main/apps/backend/src/entities"
    click Migrations "https://github.com/adatechschool/gazette/tree/main/apps/backend/src/migrations"
    click FAuth "https://github.com/adatechschool/gazette/tree/main/apps/frontend/src/app/(auth)"
    click FMain "https://github.com/adatechschool/gazette/tree/main/apps/frontend/src/app/(main)"
    click FrontendDocker "https://github.com/adatechschool/gazette/tree/main/apps/frontend/Dockerfile"
    click BackendDocker "https://github.com/adatechschool/gazette/tree/main/apps/backend/Dockerfile"
```
