# f-ernanda/travel-planner architecture

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

- Interactive diagram: https://gitdiagram.com/f-ernanda/travel-planner
- Repository: https://github.com/f-ernanda/travel-planner

## Overview

##### Project type and purpose
- Travel Ease is a full-stack, server-rendered React application built with Next.js.
- It provides a BFF (“backend-for-frontend”) API that recommends flights and hotels based on user-selected activities, querying a MongoDB data store via Prisma.
- Additional concerns include UI component development (Storybook), infrastructure provisioning (Terraform), containerization (Docker), and CI/CD (GitHub Actions).

##### File structure
- src/app – Next.js App Router “pages” and “layout”, with built-in API routes under src/app/api (flights, hotels, places, search).
- src/components & src/templates – reusable React UI components and page templates, styled with styled-components.
- src/lib/db/prisma.ts – Prisma client configuration for MongoDB.
- src/lib/mocks & src/mocks – JSON fixtures and MSW handlers for local development/testing.
- iac/*.tf – Terraform modules to provision Azure WebApp and any managed database.
- Dockerfile – container definition for the Next.js application.
- .github/workflows – CI jobs for linting, testing, building, and deploying the container to Azure.
- Storybook config – isolated UI development environment.
- Testing and linting scaffolding – Jest, React Testing Library, ESLint, Prettier, Husky pre-commit hooks.

##### Key insights from the README
- Tech stack: Next.js (Node.js/React), Prisma + MongoDB, Docker, Terraform, GitHub Actions.
- Core features: search by activity tags, lowest-price recommendation, detail pages.
- Roadmap items hint at future user auth and filter enhancements.
- Deployment workflow relies on Docker images and Terraform for Azure.

- Client (Browser / Mobile) – renders React UI, issues navigation requests and data fetches.
- Next.js Application –
– SSR/SSG front-end (React + styled-components)
– API Routes (Node.js/Express‐style handlers under src/app/api)
- Prisma Client – typed ORM abstraction layer
- MongoDB Atlas – NoSQL database instance
- Infrastructure as Code (Terraform) – Azure WebApp, environment variables, service bindings
- Containerization (Docker) – Next.js app packaged as a container image
- CI/CD Pipeline (GitHub Actions) – lint → test → build → push image → terraform apply
- Storybook (Development Tool) – isolated component playground
- Mock Server (MSW) – intercepts API calls in development/test

- Browser → Next.js Front-end (HTTP/HTTPS)
- Front-end → Next.js API Routes (fetch calls)
- API Routes → Prisma Client (function calls)
- Prisma Client → MongoDB Atlas (wire protocol)
- GitHub Actions ↔ Docker Hub / Azure (push/pull images, run Terraform)
- Terraform → Azure Resources (API calls)
- Storybook & Jest ↔ src/components + mocks (local dev/test)

c. Architectural patterns & design principles
- Monolithic “full-stack” service with built-in API routes (BFF pattern)
- Infrastructure as Code for reproducible provisioning
- Containerization for environment consistency
- Component-driven UI design (Storybook)
- Test automation via Jest and MSW

d. Key technologies & frameworks
- Next.js (App Router + API Routes)
- React + styled-components
- Prisma ORM + MongoDB
- Docker + Dockerfile
- Terraform (main.tf, providers.tf, variables.tf)
- GitHub Actions workflows (ci.yml, main_sastravelplanner.yml)
- Storybook, Jest, React Testing Library, MSW, ESLint, Prettier, Husky

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Tier
    Browser["Client (Browser/Mobile)"]:::frontend

    %% Next.js Application Tier
    subgraph "Next.js Application"
        direction TB
        FrontEnd["SSR/SSG Front-End"]:::frontend
        APIRoutes["API Routes"]:::backend
    end

    subgraph "API Routes"
        direction TB
        Flights["Flights API Route"]:::backend
        Hotels["Hotels API Route"]:::backend
        Places["Places API Route"]:::backend
        Search["Search API Route"]:::backend
    end

    %% Data Layer
    Prisma["Prisma Client"]:::data
    MongoDB["MongoDB Atlas"]:::data

    %% Development Tools
    subgraph "Development Tools"
        direction TB
        Storybook["Storybook"]:::infra
        MSW["MSW Mock Server"]:::infra
    end

    %% CI/CD & Infrastructure
    subgraph "CI/CD & Infrastructure"
        direction TB
        CICD["GitHub Actions"]:::infra
        Docker["Docker Containerization"]:::infra
        Terraform["Terraform IaC"]:::infra
        Azure["Azure Resources"]:::infra
    end

    %% Codebase Structure
    subgraph "Codebase Structure"
        direction TB
        Components["UI Components"]:::frontend
        Templates["Page Templates"]:::frontend
        Styles["Global Styles & Theme"]:::frontend
        Types["Application Types"]:::frontend
        Utils["Utility Modules"]:::backend
        Testing["Testing & Linting"]:::infra
    end

    %% Relationships
    Browser --> FrontEnd
    FrontEnd --> APIRoutes
    APIRoutes --> Flights
    APIRoutes --> Hotels
    APIRoutes --> Places
    APIRoutes --> Search
    Flights --> Prisma
    Hotels --> Prisma
    Places --> Prisma
    Search --> Prisma
    Prisma --> MongoDB

    Storybook --> FrontEnd
    MSW --> APIRoutes

    CICD --> Docker
    CICD --> Terraform
    CICD -->|push/pull images| Docker
    CICD -->|apply| Terraform
    Docker --> FrontEnd
    Terraform -->|provision| Azure

    Testing --> FrontEnd
    Testing --> APIRoutes

    %% Click Events
    click FrontEnd "https://github.com/f-ernanda/travel-planner/tree/main/src/app"
    click Flights "https://github.com/f-ernanda/travel-planner/blob/main/src/app/api/flights/route.ts"
    click Hotels "https://github.com/f-ernanda/travel-planner/blob/main/src/app/api/hotels/route.ts"
    click Places "https://github.com/f-ernanda/travel-planner/blob/main/src/app/api/places/[id]/route.ts"
    click Search "https://github.com/f-ernanda/travel-planner/blob/main/src/app/api/search/route.ts"
    click Prisma "https://github.com/f-ernanda/travel-planner/blob/main/src/lib/db/prisma.ts"
    click MongoDB "https://github.com/f-ernanda/travel-planner/blob/main/prisma/schema.prisma"
    click Docker "https://github.com/f-ernanda/travel-planner/tree/main/Dockerfile"
    click Terraform "https://github.com/f-ernanda/travel-planner/tree/main/iac"
    click CICD "https://github.com/f-ernanda/travel-planner/tree/main/.github/workflows"
    click Storybook "https://github.com/f-ernanda/travel-planner/blob/main/.storybook"
    click MSW "https://github.com/f-ernanda/travel-planner/tree/main/src/mocks"
    click Components "https://github.com/f-ernanda/travel-planner/tree/main/src/components"
    click Templates "https://github.com/f-ernanda/travel-planner/tree/main/src/templates"
    click Styles "https://github.com/f-ernanda/travel-planner/tree/main/src/styles"
    click Types "https://github.com/f-ernanda/travel-planner/tree/main/src/types"
    click Utils "https://github.com/f-ernanda/travel-planner/tree/main/src/utils"
    click Testing "https://github.com/f-ernanda/travel-planner/blob/main/jest.config.js"

    %% Styles
    classDef frontend fill:#AED6F1,stroke:#2980B9,color:#1B2631;
    classDef backend fill:#ABEBC6,stroke:#239B56,color:#1B2631;
    classDef data fill:#F9E79F,stroke:#B7950B,color:#1B2631;
    classDef infra fill:#D7DBDD,stroke:#7B7D7D,color:#1B2631;
```
