# abdullah-naeem-gh/crime_analysis_backend architecture

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

- Interactive diagram: https://gitdiagram.com/abdullah-naeem-gh/crime_analysis_backend
- Repository: https://github.com/abdullah-naeem-gh/crime_analysis_backend

## Overview

##### Project Type & Purpose
- Type: Node.js Express backend API.
- Purpose: Manage, analyze, and predict crime data; support community reports; compute safest routes; and provide AI-powered crime pattern predictions.

a. API Gateway / Express Server
- Entry point: src/index.js
- Hosts all route modules (“routes/auth.js” and src/routes/{ai, analytics, safePath}).
b. Route Handlers
- Authentication (OAuth)
- CRUD APIs for crimes, criminals, victims, stations (Supabase)
- Community Reports & Comments (MongoDB)
- Analytics (/api/analytics)
- AI Predictions (/api/ai)
- Safest Path Calculation (/api)
c. Business-Logic & Helpers (utils/)
- supabaseClient.js → PostgreSQL via Supabase
- mongodbClient.js → MongoDB
- redisClient.js → Redis cache
- geminiClient.js → Google Gemini API
- analyticsDataFetcher.js → Aggregates analytics data for AI & pathfinding
- pathfindingAlgorithm.js → OpenRouteService integration + scoring
d. External Systems
- Supabase (PostgreSQL)
- MongoDB
- Redis
- Google OAuth 2.0
- Google Gemini API
- OpenRouteService API

##### Relationships & Data Flows
Example: `/api/crimes` → supabaseClient → Supabase DB.
- For “calculate-safest-path”, route → analyticsDataFetcher → pathfindingAlgorithm → OpenRouteService → returns to client.

##### Architectural Patterns & Principles
- Layered Separation:
- Presentation/API layer (Express routes)
- Service/Business logic (analyticsDataFetcher, pathfindingAlgorithm, AI orchestration)
- Data-access layer (supabaseClient, mongodbClient, redisClient, geminiClient)
- Stateless API with external session/auth (Google OAuth).
- Caching layer (Redis) to accelerate AI predictions.
- External API integrations for AI and mapping.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients
    Client["Client / Frontend"]:::external

    %% API Layer
    subgraph "API Layer"
        API["Express Server"]:::internal
        AuthRoute["Auth Route (/api/auth)"]:::internal
        AIRoute["AI Route (/api/ai)"]:::internal
        AnalyticsRoute["Analytics Route (/api/analytics)"]:::internal
        SafePathRoute["SafePath Route (/api/safePath)"]:::internal
    end

    %% Business Logic Layer
    subgraph "Business Logic"
        AnalyticsFetcher["analyticsDataFetcher"]:::internal
        PathAlgorithm["pathfindingAlgorithm"]:::internal
    end

    %% Data Access Layer
    subgraph "Data Access"
        SupabaseClient["supabaseClient"]:::internal
        MongoDBClient["mongodbClient"]:::internal
        RedisClient["redisClient"]:::internal
        GeminiClient["geminiClient"]:::internal
    end

    %% External Services
    subgraph "External Services"
        SupabaseDB["Supabase (PostgreSQL)"]:::db
        MongoDB["MongoDB Atlas"]:::db
        RedisDB["Redis Cache"]:::db
        GoogleOAuth["Google OAuth 2.0"]:::api
        GoogleGemini["Google Gemini API"]:::api
        OpenRoute["OpenRouteService API"]:::api
    end

    %% Data Flows
    Client -->|HTTP request| API
    API -->|routes to| AuthRoute
    API -->|routes to| AIRoute
    API -->|routes to| AnalyticsRoute
    API -->|routes to| SafePathRoute

    %% Auth flows
    AuthRoute -->|OAuth redirect| GoogleOAuth
    GoogleOAuth -->|callback| AuthRoute

    %% AI Prediction Flow
    AIRoute -->|check cache| RedisClient
    RedisClient -->|cache miss| AnalyticsFetcher
    AnalyticsFetcher -->|fetch data| SupabaseClient
    AnalyticsFetcher -->|fetch data| MongoDBClient
    AnalyticsFetcher -->|call AI| GeminiClient
    GeminiClient -->|API call| GoogleGemini
    GeminiClient -->|store result| RedisClient
    RedisClient -->|return data| AIRoute

    %% Analytics Flow
    AnalyticsRoute -->|fetch analytics| AnalyticsFetcher
    AnalyticsFetcher -->|query| SupabaseClient
    AnalyticsFetcher -->|query| MongoDBClient
    AnalyticsFetcher -->|return data| AnalyticsRoute

    %% SafePath Flow
    SafePathRoute -->|fetch analytics| AnalyticsFetcher
    SafePathRoute -->|compute path| PathAlgorithm
    PathAlgorithm -->|use mapping| OpenRoute
    PathAlgorithm -->|return path| SafePathRoute

    %% Data Access to DBs
    SupabaseClient -->|SQL| SupabaseDB
    MongoDBClient -->|NoSQL| MongoDB
    RedisClient -->|cache ops| RedisDB

    %% Click Events
    click API "https://github.com/abdullah-naeem-gh/crime_analysis_backend/blob/main/src/index.js"
    click AuthRoute "https://github.com/abdullah-naeem-gh/crime_analysis_backend/blob/main/routes/auth.js"
    click AIRoute "https://github.com/abdullah-naeem-gh/crime_analysis_backend/blob/main/src/routes/ai.js"
    click AnalyticsRoute "https://github.com/abdullah-naeem-gh/crime_analysis_backend/blob/main/src/routes/analytics.js"
    click SafePathRoute "https://github.com/abdullah-naeem-gh/crime_analysis_backend/blob/main/src/routes/safePath.js"
    click SupabaseClient "https://github.com/abdullah-naeem-gh/crime_analysis_backend/blob/main/utils/supabaseClient.js"
    click MongoDBClient "https://github.com/abdullah-naeem-gh/crime_analysis_backend/blob/main/utils/mongodbClient.js"
    click RedisClient "https://github.com/abdullah-naeem-gh/crime_analysis_backend/blob/main/utils/redisClient.js"
    click GeminiClient "https://github.com/abdullah-naeem-gh/crime_analysis_backend/blob/main/utils/geminiClient.js"
    click AnalyticsFetcher "https://github.com/abdullah-naeem-gh/crime_analysis_backend/blob/main/utils/analyticsDataFetcher.js"
    click PathAlgorithm "https://github.com/abdullah-naeem-gh/crime_analysis_backend/blob/main/utils/pathfindingAlgorithm.js"

    %% Styles
    classDef internal fill:#ADD8E6,stroke:#000;
    classDef db fill:#90EE90,stroke:#000;
    classDef api fill:#FFD580,stroke:#000;
    classDef external fill:#FFC0CB,stroke:#000;
```
