# keiruu/takape architecture

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

- Interactive diagram: https://gitdiagram.com/keiruu/takape
- Repository: https://github.com/keiruu/takape

## Overview

##### Project Type and Purpose
- This is a full-stack MERN (MongoDB, Express, React, Node.js) single-page application called “Takape.ph” for finding local cafes across Panay Island.
- Front-end in React with Tailwind CSS and Firebase Authentication.
- Back-end in Node.js/Express with a REST API, using DAOs to interface with MongoDB.

##### File Structure Analysis
- Top-level directories:
- backend/ – Express API + DAO + CSV seed data
- frontend/ – React SPA with components, pages, contexts, services
- backend/api: controllers (.controller.js) + routes (.route.js) for cafés and reviews
- backend/dao: data-access layer (cafeDAO.js, reviewsDAO.js) encapsulating MongoDB operations
- frontend/src:
- components/ – reusable UI pieces
- pages/ – route-driven top-level views (Home, Cafe, Login, Signup, etc.)
- contexts/ – React Context for Auth and Café state
- services/ – HTTP client wrappers (CafeDataService.js) for the REST API
- Firebase.js – initializes Firebase Auth client
- Config files: craco.config.js (Tailwind), tailwind.config.js, package.json, server.js

##### Architecture Explanation
a. Main Components:
- Client (Browser): React SPA
- UI Components
- Routing (React Router via pages)
- AuthContext & CafeContext
- HTTP Service (axios instance in http-common.js)
- Authentication Service: Firebase Authentication (external, OAuth/JWT)
- API Gateway / Back-end: Express server (server.js → index.js)
- Routing Layer (cafes.route.js, reviews.route.js)
- Controller Layer (cafes.controller.js, reviews.controller.js)
- Data Access Layer (cafeDAO.js, reviewsDAO.js)
- Database: MongoDB (Atlas/Stitch deployment)
- Static Assets: served by React build (public/)
b. Relationships & Data Flow:
1. User interacts with React UI → triggers route change or component event
2. For protected routes, AuthContext uses Firebase SDK to sign in/up and obtain JWT
3. React service sends HTTP requests (with JWT in headers) to Express API
4. Express server’s route handler invokes controller → calls DAO
5. DAO reads/writes to MongoDB
6. Results bubble up controller → response back to client
c. Architectural Patterns & Principles:
- Layered architecture (Presentation, API, Controller, DAO, Database)
- MVC-style separation: Controllers handle HTTP logic, DAOs handle persistence
- Context API for state management in React
- Externalizing configuration (CRACO/Tailwind, env vars for DB/Firebase)
d. Key Technologies:
- React, React Router, Context API, Tailwind CSS
- Firebase Authentication SDK
- Axios (http-common.js)
- Node.js, Express.js
- MongoDB (via native driver or Mongoose inside DAOs)

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Client (React)" 
        direction TB
        ReactSPA["React SPA<br/>(React v17)"]:::client
        UI["UI Components"]:::client
        Pages["Page Routing<br/>(React Router)"]:::client
        AuthCtx["AuthContext"]:::client
        CafeCtx["CafeContext"]:::client
        HTTP["HTTP Client<br/>(axios)"]:::client
        CafeSvc["CafeDataService"]:::client
        FirebaseInit["Firebase Init"]:::client
        Static["Static Assets"]:::client
        Craco["Craco Config"]:::client
        TailwindCfg["Tailwind Config"]:::client
    end

    subgraph "External Services"
        Firebase["Firebase Auth<br/>(OAuth/JWT)"]:::external
    end

    subgraph "Server (Express)"
        direction TB
        ServerEntry["server.js<br/>(Express v4)"]:::server
        Index["index.js"]:::server
        subgraph "Routing Layer"
            direction TB
            RoutesCafes["cafes.route.js"]:::server
            RoutesReviews["reviews.route.js"]:::server
        end
        subgraph "Controller Layer"
            direction TB
            CtrCafes["cafes.controller.js"]:::server
            CtrReviews["reviews.controller.js"]:::server
        end
        subgraph "Data Access Layer"
            direction TB
            DAOcafe["cafeDAO.js"]:::server
            DAOreviews["reviewsDAO.js"]:::server
        end
        Seed["CSV Seed Data"]:::server
        BackendPkg["package.json"]:::server
    end

    subgraph "Database"
        Mongo["MongoDB Atlas"]:::database
    end

    %% Client Flow
    ReactSPA --> UI
    ReactSPA --> Pages
    Pages --> UI
    UI --> HTTP
    Pages --> HTTP
    AuthCtx --> Firebase
    Firebase -->|JWT token| AuthCtx
    HTTP -->|HTTP requests| ServerEntry

    Static --> ReactSPA

    %% Config references
    Craco -.-> ReactSPA
    TailwindCfg -.-> ReactSPA
    FirebaseInit --> AuthCtx
    HTTP --> CafeSvc
    CafeSvc --> HTTP

    %% Server Flow
    ServerEntry --> Index
    Index --> RoutesCafes
    Index --> RoutesReviews
    RoutesCafes --> CtrCafes
    RoutesReviews --> CtrReviews
    CtrCafes --> DAOcafe
    CtrReviews --> DAOreviews
    DAOcafe --> Mongo
    DAOreviews --> Mongo
    Seed --> DAOcafe

    %% Click Events
    click ReactSPA "https://github.com/keiruu/takape/tree/master/frontend/src"
    click UI "https://github.com/keiruu/takape/tree/master/frontend/src/components"
    click Pages "https://github.com/keiruu/takape/tree/master/frontend/src/pages"
    click AuthCtx "https://github.com/keiruu/takape/blob/master/frontend/src/contexts/AuthContext.js"
    click CafeCtx "https://github.com/keiruu/takape/blob/master/frontend/src/contexts/CafeContext.js"
    click HTTP "https://github.com/keiruu/takape/blob/master/frontend/src/http-common.js"
    click CafeSvc "https://github.com/keiruu/takape/blob/master/frontend/src/services/CafeDataService.js"
    click FirebaseInit "https://github.com/keiruu/takape/blob/master/frontend/src/Firebase.js"
    click Static "https://github.com/keiruu/takape/tree/master/frontend/public"
    click Craco "https://github.com/keiruu/takape/blob/master/frontend/craco.config.js"
    click TailwindCfg "https://github.com/keiruu/takape/blob/master/frontend/tailwind.config.js"
    click ServerEntry "https://github.com/keiruu/takape/blob/master/backend/server.js"
    click Index "https://github.com/keiruu/takape/blob/master/backend/index.js"
    click RoutesCafes "https://github.com/keiruu/takape/blob/master/backend/api/cafes.route.js"
    click RoutesReviews "https://github.com/keiruu/takape/blob/master/backend/api/reviews.route.js"
    click CtrCafes "https://github.com/keiruu/takape/blob/master/backend/api/cafes.controller.js"
    click CtrReviews "https://github.com/keiruu/takape/blob/master/backend/api/reviews.controller.js"
    click DAOcafe "https://github.com/keiruu/takape/blob/master/backend/dao/cafesDAO.js"
    click DAOreviews "https://github.com/keiruu/takape/blob/master/backend/dao/reviewsDAO.js"
    click Seed "https://github.com/keiruu/takape/blob/master/backend/cafe_data.csv"
    click BackendPkg "https://github.com/keiruu/takape/blob/master/backend/package.json"

    %% Styles
    classDef client fill:#D0E8FF,stroke:#000,stroke-width:1px
    classDef server fill:#D0FFD6,stroke:#000,stroke-width:1px
    classDef database fill:#FFF2CC,stroke:#000,stroke-width:1px
    classDef external fill:#E8E8E8,stroke:#000,stroke-width:1px
```
