# ncopenpass/campaignfinance architecture

> Architecture diagram of the GitHub repository ncopenpass/campaignfinance, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ncopenpass/campaignfinance
- Repository: https://github.com/ncopenpass/campaignfinance

## Overview

##### Main Components

a) Frontend Layer:
- React-based SPA (evidenced by src/components structure)
- Key feature modules:
- Search functionality
- Data visualization components
- Campaign finance analysis views
- Interactive filtering and date range selection

b) Backend Layer:
- Node.js/TypeScript server (evident from server/ directory)
- RESTful API endpoints (server/api/)
- Database interaction layer (server/db/)
- ETL processing system (server/bin/)

c) Database Layer:
- PostgreSQL database (indicated by migrations and docker-compose.yml)
- Search functionality (possibly Elasticsearch or similar, based on server/lib/search.ts)

##### Component Relationships

**[Client Browser] → [React Frontend]**
- ↓
**[API Gateway/Express Server] → [Authentication/Authorization]**
- ↓
**[Data Access Layer] → [PostgreSQL Database]**
- ↓
**[ETL Scripts] ← [External Data Sources]**

##### Specific Implementation Details

Frontend Section:
- Core components (SearchBar, Table, etc.)
- Custom hooks layer (useApi, useSearch, etc.)
- State management and data flow

API Layer:
- Distinct endpoints:
- /api/candidate
- /api/committee
- /api/contributor
- /api/expenditures
- /api/search

Database Layer:
- Migration flow
- Search indexing system
- ETL pipeline

##### Technical Stack Indicators

- React
- TypeScript
- Node.js
- PostgreSQL
- Docker
- GitHub Actions (CI/CD)

##### Additional Elements

Subsystems for:
- Data dictionary generation (scripts/createDataDictionary.js)
- Test fixtures and testing framework
- Development tools and scripts
- Deployment pipeline

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        Browser["Web Browser"]
        Browser --> FrontendApp
    end

    subgraph "Frontend Layer"
        FrontendApp["React SPA"]
        SearchUI["Search Interface"]
        DataViz["Data Visualization"]
        DateRange["Date Range Selector"]
        Filters["Input Filters"]
        
        FrontendApp --> SearchUI
        FrontendApp --> DataViz
        FrontendApp --> DateRange
        FrontendApp --> Filters
    end

    subgraph "Custom Hooks"
        ApiHook["API Hook"]
        SearchHook["Search Hook"]
        DataHooks["Data Hooks"]
    end

    subgraph "API Gateway"
        APIServer["Express Server"]
        SearchAPI["Search API"]
        CandidateAPI["Candidate API"]
        CommitteeAPI["Committee API"]
        ContributorAPI["Contributor API"]
        ExpendituresAPI["Expenditures API"]
    end

    subgraph "Data Layer"
        DAL["Data Access Layer"]
        SearchSystem["Search System"]
        Database[(PostgreSQL)]
    end

    subgraph "ETL System"
        ETLMain["ETL Process"]
        CSVImport["CSV Import"]
        CSVExport["CSV Export"]
        ExtData["External Data Sources"]
    end

    subgraph "Development"
        Tests["Test Suite"]
        DataDict["Data Dictionary"]
        CICD["CI/CD Pipeline"]
    end

    %% Frontend Connections
    FrontendApp --> ApiHook
    SearchUI --> SearchHook
    DataViz --> DataHooks

    %% API Connections
    ApiHook --> APIServer
    SearchHook --> SearchAPI
    DataHooks --> APIServer

    %% Backend Connections
    APIServer --> DAL
    SearchAPI --> SearchSystem
    DAL --> Database
    SearchSystem --> Database

    %% ETL Connections
    ETLMain --> Database
    CSVImport --> ETLMain
    ETLMain --> CSVExport
    ExtData --> ETLMain

    %% Click Events
    click FrontendApp "https://github.com/ncopenpass/CampaignFinance/blob/master/src/components/App.js"
    click SearchUI "https://github.com/ncopenpass/CampaignFinance/blob/master/src/components/SearchBar.js"
    click DataViz "https://github.com/ncopenpass/CampaignFinance/blob/master/src/components/SearchResultTable.js"
    click DateRange "https://github.com/ncopenpass/CampaignFinance/blob/master/src/components/DateRange.js"
    click Filters "https://github.com/ncopenpass/CampaignFinance/blob/master/src/components/InputFilter.js"
    click ApiHook "https://github.com/ncopenpass/CampaignFinance/blob/master/src/hooks/useApi.js"
    click SearchHook "https://github.com/ncopenpass/CampaignFinance/blob/master/src/hooks/useSearch.js"
    click DataHooks "https://github.com/ncopenpass/CampaignFinance/blob/master/src/hooks/useCandidate.js"
    click SearchAPI "https://github.com/ncopenpass/CampaignFinance/blob/master/server/api/search.ts"
    click CandidateAPI "https://github.com/ncopenpass/CampaignFinance/blob/master/server/api/candidate.ts"
    click CommitteeAPI "https://github.com/ncopenpass/CampaignFinance/blob/master/server/api/committee.ts"
    click ContributorAPI "https://github.com/ncopenpass/CampaignFinance/blob/master/server/api/contributor.ts"
    click ExpendituresAPI "https://github.com/ncopenpass/CampaignFinance/blob/master/server/api/expenditures.ts"
    click SearchSystem "https://github.com/ncopenpass/CampaignFinance/blob/master/server/lib/search.ts"
    click DAL "https://github.com/ncopenpass/CampaignFinance/blob/master/server/db/index.ts"
    click ETLMain "https://github.com/ncopenpass/CampaignFinance/blob/master/server/bin/etl.ts"
    click CSVImport "https://github.com/ncopenpass/CampaignFinance/blob/master/server/bin/importFromCSV.ts"
    click CSVExport "https://github.com/ncopenpass/CampaignFinance/blob/master/server/bin/exportToCSV.ts"
    click Tests "https://github.com/ncopenpass/CampaignFinance/blob/master/server/test/test-routes.test.ts"
    click DataDict "https://github.com/ncopenpass/CampaignFinance/blob/master/scripts/createDataDictionary.js"
    click CICD "https://github.com/ncopenpass/CampaignFinance/blob/master/.github/workflows/build-and-test.yml"

    %% Styling
    classDef frontend fill:#3498db,stroke:#2980b9,color:white
    classDef api fill:#2ecc71,stroke:#27ae60,color:white
    classDef database fill:#f1c40f,stroke:#f39c12,color:black
    classDef etl fill:#9b59b6,stroke:#8e44ad,color:white
    classDef development fill:#e74c3c,stroke:#c0392b,color:white

    class FrontendApp,SearchUI,DataViz,DateRange,Filters frontend
    class APIServer,SearchAPI,CandidateAPI,CommitteeAPI,ContributorAPI,ExpendituresAPI api
    class DAL,Database,SearchSystem database
    class ETLMain,CSVImport,CSVExport,ExtData etl
    class Tests,DataDict,CICD development
```
