# bumgeunsong/daily-writing-friends architecture

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

- Interactive diagram: https://gitdiagram.com/bumgeunsong/daily-writing-friends
- Repository: https://github.com/bumgeunsong/daily-writing-friends

## Overview

##### Project Type and Purpose
- Full-stack, serverless web application (“Daily Writing Friends”)
- Frontend: React + TypeScript SPA built with Vite
- Backend: Firebase BaaS (Authentication, Firestore, Cloud Functions, Hosting, Cloud Messaging)
- Purpose: help users build a daily writing habit with posting, commenting, notifications, and writing history tracking.

##### Top-Level File Structure and Architectural Clues
- firebase.json / .firebaserc / firestore_schema.txt → Firebase services config, Firestore schema
- functions/ → TypeScript Cloud Functions organized by domain (postings, commentings, replyings, writingHistory, notifications)
- public/ → static assets (manifest, service-worker for push notifications)
- src/ → React app source
- components/ (pages, UI primitives, navigation)
- contexts/ (Auth, Navigation, UI state)
- hooks/ (data fetching, state management, Firebase integrations)
- lib/ (React Query client, util functions)
- firebase.ts / messaging.ts → Firebase client SDK initialization and message handling
- index.html, vite.config.ts, tailwind.config.js → build and styling pipeline

##### Key Components
A. Frontend (Browser SPA)
- React layers: UI components, Contexts, Hooks
- Client-side Firebase SDKs: Auth, Firestore, Cloud Messaging
- Service Worker for push notifications (public/firebase-messaging-sw.js)
B. Firebase Hosting
- Serves index.html and static assets to users
C. Firebase Authentication
- Manages user sign-up, sign-in, session tokens
D. Cloud Firestore
- Storage of posts, comments, replies, notifications, writing history
- Real-time listeners on collections
E. Cloud Functions (Serverless Backends)
- Triggered by Firestore writes (create/update postings, commentings, replyings)
- Functions for notifications, counters, writing history, batching updates
- messageGenerator.ts + sendMessageOnNotification.ts → push notifications via Firebase Messaging
F. Firebase Cloud Messaging
- Delivers push notifications to the Service Worker in the browser
G. External Monitoring (Sentry / Centry)
- Error / performance monitoring (centry.ts integration)

##### Relationships and Data Flows
- User browser ↔ Firebase Auth (login, token refresh)
- Browser ↔ Firestore (read/write via React Query & custom hooks)
- Firestore write triggers → Cloud Function event handlers → update Firestore / send messages
- Cloud Function push → Firebase Cloud Messaging → Service Worker → Browser UI (toast notifications)
- Hosting serves SPA assets; SPA bootstraps connections to Auth, Firestore, Messaging

##### Architectural Patterns and Design Principles
- Serverless / event-driven microservices: each Cloud Function handles a single Firestore trigger or task
- SPA with clear separation of concerns: components / hooks / contexts / utils
- Real-time subscriptions for UI reactivity
- Domain-driven grouping: postings, commentings, replyings, writingHistory, notifications

##### Detail Level
- Service Worker flow for push notifications
- Real-time Firestore listeners used by React hooks
- Sentry/Centry integration as a side component tied to both client and Cloud Functions for monitoring

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Layer
    subgraph "Client (Browser)" 
        direction TB
        SPA["React SPA (Vite, TypeScript)"]:::frontend
        Components["UI Components"]:::frontend
        Contexts["React Contexts"]:::frontend
        AuthContext["AuthContext.tsx"]:::frontend
        Hooks["Custom Hooks"]:::frontend
        QueryClient["QueryClient.ts"]:::frontend
        FirebaseInit["firebase.ts"]:::frontend
        MessagingClient["messaging.ts"]:::frontend
        ServiceWorker["Service Worker"]:::frontend
        MonitoringClient["centry.ts"]:::monitoring
    end

    %% Firebase Managed Services
    subgraph "Firebase Managed Services"
        direction TB
        Hosting["Firebase Hosting"]:::firebase
        Auth["Firebase Authentication"]:::firebase
        Firestore["Cloud Firestore"]:::firebase
        Messaging["Cloud Messaging"]:::firebase
    end

    %% Serverless Logic
    subgraph "Cloud Functions"
        direction TB
        CFIndex["index.ts"]:::functions
        subgraph "Postings"
            CP["createPosting"]:::functions
            UP["updatePosting"]:::functions
        end
        subgraph "Commentings"
            CC["createCommenting"]:::functions
            UC["updateCommenting"]:::functions
        end
        subgraph "Replyings"
            CR["createReplying"]:::functions
            UR["updateReplying"]:::functions
        end
        subgraph "WritingHistory"
            WPC["createWritingHistoryOnPostCreated"]:::functions
            WD["deleteWritingHistoryOnPostDeleted"]:::functions
            WS["getWritingStats"]:::functions
            WB["other WritingHistory"]:::functions
        end
        subgraph "Notifications"
            MG["messageGenerator"]:::functions
            SM["sendMessageOnNotification"]:::functions
            NB["other Notifications"]:::functions
        end
        Types["types"]:::functions
    end

    %% Connections
    SPA -->|loads assets| Hosting
    Hosting -->|serves SPA| SPA
    SPA -->|login/signup| Auth
    SPA -->|read/write| Firestore
    SPA -->|subscribe| Messaging
    Messaging -->|push events| ServiceWorker
    ServiceWorker -->|deliver push| SPA
    SPA -->|init SDK| FirebaseInit
    SPA -->|init Messaging| MessagingClient
    SPA -->|use queries| QueryClient
    SPA -->|use hooks| Hooks
    SPA -->|use contexts| Contexts
    SPA -->|monitor errors| MonitoringClient
    Contexts -->|provides| AuthContext

    Firestore -->|onCreate/onUpdate| CP & CC & CR & WPC
    CP -->|writes| Firestore
    UP -->|updates| Firestore
    CC -->|writes| Firestore
    UC -->|updates| Firestore
    CR -->|writes| Firestore
    UR -->|updates| Firestore
    WPC -->|writes| Firestore
    WD -->|deletes| Firestore
    WS -->|reads stats| Firestore
    MG -->|generate messages| Firestore
    SM -->|send via| Messaging
    CFIndex -->|registers funcs| CP & UP & CC & UC & CR & UR & WPC & WD & WS & MG & SM & Types
    CFIndex -->|monitors| MonitoringClient

    %% Click Events - Client
    click Components "https://github.com/bumgeunsong/daily-writing-friends/tree/main/src/components/"
    click Contexts "https://github.com/bumgeunsong/daily-writing-friends/tree/main/src/contexts/"
    click AuthContext "https://github.com/bumgeunsong/daily-writing-friends/blob/main/src/contexts/AuthContext.tsx"
    click Hooks "https://github.com/bumgeunsong/daily-writing-friends/tree/main/src/hooks/"
    click QueryClient "https://github.com/bumgeunsong/daily-writing-friends/blob/main/src/lib/QueryClient.ts"
    click FirebaseInit "https://github.com/bumgeunsong/daily-writing-friends/blob/main/src/firebase.ts"
    click MessagingClient "https://github.com/bumgeunsong/daily-writing-friends/blob/main/src/messaging.ts"
    click ServiceWorker "https://github.com/bumgeunsong/daily-writing-friends/blob/main/public/firebase-messaging-sw.js"
    click MonitoringClient "https://github.com/bumgeunsong/daily-writing-friends/blob/main/src/centry.ts"
    click Hosting "https://github.com/bumgeunsong/daily-writing-friends/blob/main/firebase.json"
    %% Click Events - Cloud Functions
    click CFIndex "https://github.com/bumgeunsong/daily-writing-friends/blob/main/functions/src/index.ts"
    click CP "https://github.com/bumgeunsong/daily-writing-friends/blob/main/functions/src/postings/createPosting.ts"
    click UP "https://github.com/bumgeunsong/daily-writing-friends/blob/main/functions/src/postings/updatePosting.ts"
    click CC "https://github.com/bumgeunsong/daily-writing-friends/blob/main/functions/src/commentings/createCommenting.ts"
    click UC "https://github.com/bumgeunsong/daily-writing-friends/blob/main/functions/src/commentings/updateCommenting.ts"
    click CR "https://github.com/bumgeunsong/daily-writing-friends/blob/main/functions/src/replyings/createReplying.ts"
    click UR "https://github.com/bumgeunsong/daily-writing-friends/blob/main/functions/src/replyings/updateReplying.ts"
    click WPC "https://github.com/bumgeunsong/daily-writing-friends/blob/main/functions/src/writingHistory/createWritingHistoryOnPostCreated.ts"
    click WD "https://github.com/bumgeunsong/daily-writing-friends/blob/main/functions/src/writingHistory/deleteWritingHistoryOnPostDeleted.ts"
    click WS "https://github.com/bumgeunsong/daily-writing-friends/blob/main/functions/src/writingHistory/getWritingStats.ts"
    click MG "https://github.com/bumgeunsong/daily-writing-friends/blob/main/functions/src/notifications/messageGenerator.ts"
    click SM "https://github.com/bumgeunsong/daily-writing-friends/blob/main/functions/src/notifications/sendMessageOnNotification.ts"
    click Types "https://github.com/bumgeunsong/daily-writing-friends/tree/main/functions/src/types/"

    %% Styles
    classDef frontend fill:#AED6F1,stroke:#217DBB,color:#000
    classDef firebase fill:#ABEBC6,stroke:#239B56,color:#000
    classDef functions fill:#F9E79F,stroke:#B7950B,color:#000
    classDef monitoring fill:#F5B7B1,stroke:#C0392B,color:#000
```
