# rajeev-k/eureka architecture

> Architecture diagram of the GitHub repository rajeev-k/eureka, 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/rajeev-k/eureka
- Repository: https://github.com/rajeev-k/eureka

## Overview

##### Main Components

a. Frontend Layer:
- Single Page Application (SPA) built with TypeScript
- Key components:
- Search interface
- Admin interface
- File viewer (Monaco editor)
- History viewer
- Diff viewer

b. Backend Layer:
- Java-based web service
- RESTful API endpoints
- Core services:
- Search Engine (Lucene-based)
- Git Service
- Source Code Analyzer

c. Storage Layer:
- Local file system mount (Docker volume)
- Git repository integration (optional)

d. Container Infrastructure:
- Docker container
- Volume mapping
- Port mapping (8888:8080)

**[Client Browser] → Port 8888**
- ↓
**[Docker Container (8080)]**
- Frontend (TypeScript SPA)
- Search UI
- Admin UI
- Monaco Editor
- Git Integration UI

- Backend (Java WebService)
- Search Service
- Git Service
- Source Code Analyzer

- Storage
- Docker Volume Mount
- Local Git Repositories

##### Key Interactions to Highlight

a. External Interactions:
- Browser to Docker container communication
- Docker volume mapping to host file system

b. Internal Interactions:
- Frontend to Backend API calls
- Backend services interaction with file system
- Search engine indexing flow
- Git integration flow

##### Implementation Details

a. Technologies:
- TypeScript/JavaScript (Frontend)
- Java (Backend)
- Lucene (Search Engine)
- Monaco Editor (Code Viewer)
- Docker (Container)

b. Key Files/Components:
- SearchService.java
- GitService.java
- SearchEngine.java
- AdminController.ts
- SearchController.ts

## Diagram (Mermaid)

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

    subgraph Docker["Docker Container (Port 8888:8080)"]
        subgraph FrontendLayer["Frontend Layer"]
            SearchUI["Search Interface"]:::frontend
            AdminUI["Admin Interface"]:::frontend
            FileViewer["File Viewer"]:::frontend
            HistoryViewer["History Viewer"]:::frontend
            DiffViewer["Diff Viewer"]:::frontend
            MonacoEditor["Monaco Editor"]:::frontend
        end

        subgraph BackendLayer["Backend Layer"]
            SearchService["Search Service"]:::backend
            GitService["Git Service"]:::backend
            CodeAnalyzer["Source Code Analyzer"]:::backend
            SearchEngine["Search Engine (Lucene)"]:::backend
        end

        subgraph Storage["Storage Layer"]
            DockerVolume["Docker Volume Mount"]:::storage
            GitRepos["Local Git Repositories"]:::storage
        end
    end

    %% External Interactions
    Browser --> |"HTTP/HTTPS"| Docker

    %% Frontend Interactions
    SearchUI --> SearchService
    AdminUI --> SearchService
    FileViewer --> GitService
    HistoryViewer --> GitService
    DiffViewer --> GitService
    FileViewer --> MonacoEditor

    %% Backend Interactions
    SearchService --> SearchEngine
    SearchService --> CodeAnalyzer
    GitService --> GitRepos
    SearchEngine --> DockerVolume
    CodeAnalyzer --> DockerVolume

    %% Click Events
    click SearchUI "https://github.com/rajeev-k/eureka/blob/master/webapp/ClientApp/controllers/SearchController.ts"
    click AdminUI "https://github.com/rajeev-k/eureka/blob/master/webapp/ClientApp/controllers/AdminController.ts"
    click FileViewer "https://github.com/rajeev-k/eureka/blob/master/webapp/ClientApp/views/SourceCodeViewer.tsx"
    click HistoryViewer "https://github.com/rajeev-k/eureka/blob/master/webapp/ClientApp/controllers/HistoryController.ts"
    click DiffViewer "https://github.com/rajeev-k/eureka/blob/master/webapp/ClientApp/controllers/DiffController.ts"
    click MonacoEditor "https://github.com/rajeev-k/eureka/tree/master/webapp/wwwroot/monaco-editor"
    click SearchEngine "https://github.com/rajeev-k/eureka/blob/master/webservice/src/main/java/eureka/SearchEngine.java"
    click GitService "https://github.com/rajeev-k/eureka/blob/master/webservice/src/main/java/eureka/GitService.java"
    click CodeAnalyzer "https://github.com/rajeev-k/eureka/blob/master/webservice/src/main/java/eureka/SourceCodeAnalyzer.java"
    click SearchService "https://github.com/rajeev-k/eureka/blob/master/webservice/src/main/java/eureka/SearchService.java"
    click Docker "https://github.com/rajeev-k/eureka/tree/master/base-image/Dockerfile"

    %% Styling
    classDef frontend fill:#2196F3,stroke:#1565C0,color:white
    classDef backend fill:#4CAF50,stroke:#2E7D32,color:white
    classDef storage fill:#FFC107,stroke:#FFA000,color:black
    classDef infrastructure fill:#9E9E9E,stroke:#616161,color:white

    %% Legend
    subgraph Legend
        Frontend["Frontend Component"]:::frontend
        Backend["Backend Component"]:::backend
        Store["Storage Component"]:::storage
        Infra["Infrastructure"]:::infrastructure
    end
```
