How f-ernanda/travel-planner works
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