# ikaushiksharma/costkeeper architecture

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

- Interactive diagram: https://gitdiagram.com/ikaushiksharma/costkeeper
- Repository: https://github.com/ikaushiksharma/costkeeper

## Overview

##### Project type and purpose
- This is a full-stack, Next.js 13 application (using the new App Router) that implements a personal finance dashboard (accounts, categories, transactions, summary, settings).
- It bundles a React-based front end with server-side API routes, PWA/offline support, and a relational database (via Drizzle ORM).

##### File structure
- Top-level “app” directory houses both UI pages (app/(auth), app/(dashboard), app/offline) and API routes (app/api/…/route.ts).
- “components”, “features” and “providers” contain React UI elements, domain-specific hooks and context providers (e.g., React Query, theming, sheet modals).
- “db” and “drizzle.config.ts” configure the database schema and Drizzle ORM.
- Service worker and PWA assets live under “public” (sw.js, workbox).
- Build/configuration files: next.config.js, tailwind.config.ts, bun.lockb (uses Bun), ESLint/Husky/prettier for linting/formatting.

##### Readme insights
- (empty README, but file names convey architecture: App Router, API routes, Drizzle for data persistence, Hono middleware, PWA support)

Zone A: Client
- Browser
- UI Routes (pages)
- React Query Provider
- Feature Hooks & Components
- Service Worker (intercepts requests)
Zone B: Server
- Next.js App Router (SSR/SSG)
- API Routes (/app/api/…/route.ts)
- Middleware (Hono, auth checks)
Zone C: Persistence
- Drizzle ORM layer
- SQL Database
Zone D: Dev / Build Tools (optional overlay)
- Bun runtime
- Tailwind
- ESLint/Husky/Prettier

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Zone A: Client
    subgraph "Client (Browser)" 
        direction TB
        UI_Routes["UI Routes<br/>(app/(auth), app/(dashboard), app/offline)"]:::client
        click UI_Routes "https://github.com/ikaushiksharma/costkeeper/tree/main/app/(auth)"
        click UI_Routes "https://github.com/ikaushiksharma/costkeeper/tree/main/app/(dashboard)"
        click UI_Routes "https://github.com/ikaushiksharma/costkeeper/tree/main/app/offline"
        click UI_Routes "https://github.com/ikaushiksharma/costkeeper/blob/main/app/layout.tsx"
        React_Query["React Query Provider"]:::client
        click React_Query "https://github.com/ikaushiksharma/costkeeper/blob/main/providers/query-provider.tsx"
        Sheet_Provider["Sheet Modals Provider"]:::client
        click Sheet_Provider "https://github.com/ikaushiksharma/costkeeper/blob/main/providers/sheet-provider.tsx"
        Theme_Provider["Theme Provider"]:::client
        click Theme_Provider "https://github.com/ikaushiksharma/costkeeper/blob/main/providers/theme-provider.tsx"
        Feature_Hooks["Feature Hooks & Components"]:::client
        click Feature_Hooks "https://github.com/ikaushiksharma/costkeeper/tree/main/components/ui"
        Service_Worker["Service Worker"]:::pwa
        click Service_Worker "https://github.com/ikaushiksharma/costkeeper/blob/main/public/sw.js"
    end

    %% Domain Services under client
    subgraph "Domain Services" 
        direction TB
        Accounts["Accounts Feature"]:::client
        click Accounts "https://github.com/ikaushiksharma/costkeeper/tree/main/features/accounts"
        click Accounts "https://github.com/ikaushiksharma/costkeeper/tree/main/app/(dashboard)/accounts"
        Categories["Categories Feature"]:::client
        click Categories "https://github.com/ikaushiksharma/costkeeper/tree/main/features/categories"
        click Categories "https://github.com/ikaushiksharma/costkeeper/tree/main/app/(dashboard)/categories"
        Transactions["Transactions Feature"]:::client
        click Transactions "https://github.com/ikaushiksharma/costkeeper/tree/main/features/transactions"
        click Transactions "https://github.com/ikaushiksharma/costkeeper/tree/main/app/(dashboard)/transactions"
        Summary_Feature["Summary Feature"]:::client
        click Summary_Feature "https://github.com/ikaushiksharma/costkeeper/tree/main/features/summary"
        Settings_Feature["Settings Feature"]:::client
        click Settings_Feature "https://github.com/ikaushiksharma/costkeeper/tree/main/features/settings"
        click Settings_Feature "https://github.com/ikaushiksharma/costkeeper/blob/main/app/(dashboard)/settings/page.tsx"
    end

    %% Zone B: Server
    subgraph "Server (Next.js)" 
        direction TB
        App_Router["Next.js App Router"]:::server
        click App_Router "https://github.com/ikaushiksharma/costkeeper/blob/main/app/layout.tsx"
        subgraph "API Routes" 
            direction TB
            API_Accounts["/api/accounts"]:::server
            click API_Accounts "https://github.com/ikaushiksharma/costkeeper/blob/main/app/api/[[...route]]/accounts.ts"
            API_Categories["/api/categories"]:::server
            click API_Categories "https://github.com/ikaushiksharma/costkeeper/blob/main/app/api/[[...route]]/categories.ts"
            API_Transactions["/api/transactions"]:::server
            click API_Transactions "https://github.com/ikaushiksharma/costkeeper/blob/main/app/api/[[...route]]/transactions.ts"
            API_Summary["/api/summary"]:::server
            click API_Summary "https://github.com/ikaushiksharma/costkeeper/blob/main/app/api/[[...route]]/summary.ts"
            API_Settings["/api/settings"]:::server
            click API_Settings "https://github.com/ikaushiksharma/costkeeper/blob/main/app/api/[[...route]]/settings.ts"
        end
        Middleware["Hono Middleware"]:::server
        click Middleware "https://github.com/ikaushiksharma/costkeeper/blob/main/lib/hono.ts"
        click Middleware "https://github.com/ikaushiksharma/costkeeper/blob/main/middleware.ts"
    end

    %% Zone C: Persistence
    subgraph "Persistence Layer" 
        direction TB
        Drizzle_Config["Drizzle Config"]:::db
        click Drizzle_Config "https://github.com/ikaushiksharma/costkeeper/blob/main/drizzle.config.ts"
        Schema["DB Schema"]:::db
        click Schema "https://github.com/ikaushiksharma/costkeeper/blob/main/db/schema.ts"
        Drizzle_Driver["Drizzle ORM"]:::db
        click Drizzle_Driver "https://github.com/ikaushiksharma/costkeeper/blob/main/db/drizzle.ts"
        Database["SQL Database"]:::db
    end

    %% Zone D: PWA Assets
    subgraph "PWA & Offline" 
        direction TB
        Workbox["Workbox Scripts"]:::pwa
        click Workbox "https://github.com/ikaushiksharma/costkeeper/blob/main/public/workbox-*.js"
        Manifest["Manifest"]:::pwa
        click Manifest "https://github.com/ikaushiksharma/costkeeper/blob/main/public/manifest.json"
    end

    %% Zone E: Build & Tools
    subgraph "Build & Dev Tools" 
        direction TB
        Bun["Bun Runtime"]:::tools
        Tailwind["Tailwind CSS"]:::tools
        ESLint["ESLint/Husky/Prettier"]:::tools
    end

    %% Connections
    UI_Routes -->|renders via| App_Router
    UI_Routes -->|wraps with| React_Query
    React_Query -->|fetches from| API_Accounts
    React_Query -->|fetches from| API_Categories
    React_Query -->|fetches from| API_Transactions
    React_Query -->|fetches from| API_Summary
    React_Query -->|fetches from| API_Settings
    Feature_Hooks -->|uses| React_Query
    Service_Worker -->|intercepts| API_Accounts
    Service_Worker -->|intercepts| API_Categories
    Service_Worker -->|intercepts| API_Transactions
    Service_Worker -->|intercepts| API_Summary
    Service_Worker -->|intercepts| API_Settings
    API_Accounts -->|passes through| Middleware
    API_Categories -->|passes through| Middleware
    API_Transactions -->|passes through| Middleware
    API_Summary -->|passes through| Middleware
    API_Settings -->|passes through| Middleware
    Middleware -->|calls| Drizzle_Driver
    Drizzle_Driver -->|query| Database

    %% Styles
    classDef client fill:#D0E7FF,stroke:#333,stroke-width:1px;
    classDef server fill:#D0FFD0,stroke:#333,stroke-width:1px;
    classDef db fill:#FFE0B2,stroke:#333,stroke-width:1px;
    classDef pwa fill:#E0E0E0,stroke:#333,stroke-width:1px;
    classDef tools fill:#F0F0F0,stroke:#333,stroke-width:1px;
```
