# aneeshbukya/empowerhr--ai-powered-hr-agents architecture

> Architecture diagram of the GitHub repository aneeshbukya/empowerhr--ai-powered-hr-agents, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/aneeshbukya/empowerhr--ai-powered-hr-agents
- Repository: https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents

## Overview

##### Project type and purpose
- EmpowerHR is a full-stack Django web application that automates HR tasks using AI.
- Key user-facing functions: candidate note summarization, FAQ answering from a policy doc, and sending onboarding emails.

##### File structure
- Top-level “HRAgentUI/” directory contains the Django project:
- HRAgentUI/HRAgentUI/ – Django settings, URL router, ASGI/WSGI entry points, view modules (email.py, faq.py, notes.py)
- templates/ – HTML pages for home, about, notes, faq, onboarding
- static/ – CSS and JS assets per feature
- db.sqlite3 & HRAgentUI/db/ – SQLite database plus a Chroma vector store (embeddings in .bin files)
- Dockerfile, .dockerignore, Procfile, fly.toml – containerization and deployment config
- There’s also a top-level “src/main.py” script (likely CLI or orchestration) and a docs folder holding the Employee Code of Conduct .docx

##### README for additional insights
- Confirms use of Django (MVT pattern), smtplib/ssl for email, dotenv for env variables, and a custom “crewai” library for defining AI agents/tasks.
- External dependencies: OpenAI, SERPER, EXA APIs

a. Components to include
- Client (Web Browser)
- Django App Server
– URL Router
– Controllers/Views: HomeController, NotesAgentController, FAQAgentController, OnboardingController
– Agent Layer (crewai): NoteSummarizerAgent, FAQAgent, EmailAgent
– Data Access Layer: Django ORM + raw Chroma API for embeddings
- Databases
– SQLite (relational data, user sessions, metadata)
– Chroma vector store (binary .bin files under /db for embedding search)
- File Store: local docs directory with Employee-Code-of-Conduct.docx
- External Services
– OpenAI API (language model calls)
– SERPER API (search)
– EXA API (if used)
– SMTP Server (Gmail via smtplib/ssl)
- Deployment
– Docker Container (Dockerfile)
– PaaS (Fly.io via fly.toml)

b. Relationships and interactions
- View → Agent Layer → External AI APIs / Vector DB
- NotesAgentController:
→ reads uploaded text file → passes to NoteSummarizerAgent → optionally stores/fetches embeddings from Chroma → returns summary to template
- FAQAgentController:
→ loads .docx policy file → creates embeddings or searches Chroma → calls OpenAI to generate answers → displays response
- OnboardingController:
→ collects form data → EmailAgent composes content via OpenAI → sends via SMTP server
- Django ORM ↔ SQLite for user uploads, logs, metadata

c. Architectural patterns and design principles
- Django’s MVT (Model-View-Template) separates concerns
- Agent-based modularization: each HR function encapsulated in its own controller + crewai agent
- Vector store abstraction for retrieval-augmented generation (RAG)
- Containerization for reproducible deployments

d. Key technologies/frameworks
- Backend: Python 3.x, Django
- Frontend: Django Templates + static CSS/JS
- Datastores: SQLite, Chroma vector DB
- AI & search: OpenAI API, SERPER API, crewai library
- Email: smtplib + ssl
- DevOps: Docker, Fly.io

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User
    Browser["Web Browser"]:::frontend

    %% Django Server
    subgraph "Django Web Server"
        direction TB
        Router["URL Router"]:::backend
        HomeCtrl["HomeController"]:::backend
        NotesCtrl["NotesAgentController"]:::backend
        FAQCtrl["FAQAgentController"]:::backend
        OnboardingCtrl["OnboardingController"]:::backend

        subgraph "Agent Layer"
            direction TB
            NoteAgent["NoteSummarizerAgent"]:::backend
            FAQAgent["FAQAgent"]:::backend
            EmailAgent["EmailAgent"]:::backend
        end

        subgraph "Data Access Layer"
            direction TB
            ORM["Django ORM"]:::backend
            ChromaAPI["Chroma Vector API"]:::backend
        end
    end

    %% Templates and Static
    subgraph "UI Assets"
        direction TB
        Templates["Templates"]:::frontend
        StaticCSS["CSS Files"]:::frontend
        StaticJS["JS Files"]:::frontend
    end

    %% Datastores
    subgraph "Data Stores"
        direction TB
        SQLiteDB["SQLite Database"]:::datastore
        ChromaDB["Chroma Vector Store"]:::datastore
        PolicyDoc["Employee-Code-of-Conduct.docx"]:::datastore
    end

    %% External Services
    subgraph "External Services"
        direction TB
        OpenAI["OpenAI API"]:::external
        SERPER["SERPER API"]:::external
        EXA["EXA API"]:::external
        SMTP["SMTP Server"]:::external
    end

    %% Deployment
    subgraph "Deployment"
        direction TB
        Docker["Docker Container"]:::deployment
        FlyIO["Fly.io PaaS"]:::deployment
    end

    %% CLI Script
    CLI["CLI Script (main.py)"]:::backend

    %% Connections
    Browser -->|"HTTP Request"| Router
    Router --> HomeCtrl
    Router --> NotesCtrl
    Router --> FAQCtrl
    Router --> OnboardingCtrl

    HomeCtrl --> Templates
    NotesCtrl --> NoteAgent
    FAQCtrl --> FAQAgent
    OnboardingCtrl --> EmailAgent

    NoteAgent --> ChromaAPI
    NoteAgent --> OpenAI
    NoteAgent --> ChromaDB
    FAQAgent --> ChromaDB
    FAQAgent --> OpenAI
    FAQAgent --> PolicyDoc
    EmailAgent --> OpenAI
    EmailAgent --> SMTP

    HomeCtrl --> ORM
    NotesCtrl --> ORM
    FAQCtrl --> ORM
    OnboardingCtrl --> ORM

    ORM --> SQLiteDB

    Browser --> Templates
    Browser --> StaticCSS
    Browser --> StaticJS

    Docker --> Router
    Docker --> HomeCtrl
    Docker --> NotesCtrl
    Docker --> FAQCtrl
    Docker --> OnboardingCtrl
    Docker --> Docker
    Docker --> FlyIO

    CLI --> Router

    %% Click Events
    click Router "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/blob/main/HRAgentUI/HRAgentUI/urls.py"
    click HomeCtrl "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/blob/main/HRAgentUI/HRAgentUI/views.py"
    click NotesCtrl "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/blob/main/HRAgentUI/HRAgentUI/notes.py"
    click NoteAgent "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/blob/main/HRAgentUI/HRAgentUI/notes.py"
    click FAQCtrl "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/blob/main/HRAgentUI/HRAgentUI/faq.py"
    click FAQAgent "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/blob/main/HRAgentUI/HRAgentUI/faq.py"
    click OnboardingCtrl "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/blob/main/HRAgentUI/HRAgentUI/email.py"
    click EmailAgent "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/blob/main/HRAgentUI/HRAgentUI/email.py"
    click Templates "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/tree/main/HRAgentUI/templates/"
    click StaticCSS "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/tree/main/HRAgentUI/static/css/"
    click StaticJS "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/tree/main/HRAgentUI/static/js/"
    click SQLiteDB "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/blob/main/HRAgentUI/db.sqlite3"
    click ChromaDB "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/tree/main/HRAgentUI/db/"
    click PolicyDoc "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/blob/main/docs/Employee-Code-of-Conduct.docx"
    click CLI "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/blob/main/src/main.py"
    click Docker "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/tree/main/HRAgentUI/Dockerfile"
    click FlyIO "https://github.com/aneeshbukya/empowerhr--ai-powered-hr-agents/blob/main/HRAgentUI/fly.toml"

    %% Styles
    classDef frontend fill:#D0E7FF,stroke:#0685FF,color:#004A8F
    classDef backend fill:#DFF7E1,stroke:#2E8B57,color:#006400
    classDef datastore fill:#FFE7C1,stroke:#FF8C00,color:#8B4500
    classDef external fill:#F3D1FF,stroke:#800080,color:#4B0082
    classDef deployment fill:#E8E8E8,stroke:#A9A9A9,color:#333333
```
