# atharvasingh312/hirehelp architecture

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

- Interactive diagram: https://gitdiagram.com/atharvasingh312/hirehelp
- Repository: https://github.com/atharvasingh312/hirehelp

## Overview

##### Main system components
- Backend Server: The Django project itself, represented by the main configuration directory (HireHelp) and the recruitment_app. These components would include Django’s settings, URL routing, views, models, and any integrated business logic.
- Application Modules: Within recruitment_app, individual modules handle functions like resume parsing (resume_parser.py), machine-learning based data extraction (mlmodel.py and extract_textual_data.py), and interview scheduling (interview_scheduler.py).
- Database: A MySQL database is used (configured in settings.py per the README instructions). The database stores authentication records (user table) along with table structures for jobs, interviewers, candidates, applications, and scheduled interviews.
- Static Assets and Templates: The static directory (with CSS, JS, images) and templates directory (HTML files) support the front-end presentation layer, ensuring a clear separation of concerns.
- Deployment and Environment: Note the presence of the asgi.py and wsgi.py files in the HireHelp directory, which facilitate the deployment in various environments (asynchronous vs. synchronous).

##### Relationships and interactions
- Client (Browser) interacts with the Django backend through HTTP requests. The views (in recruitment_app/views.py) then process these requests, perhaps invoking the machine learning utilities and retrieving data from the MySQL database.
- The Django ORM is used to map models to database tables, as defined by the SQL scripts in the README. There is a bidirectional flow between the web application and the database: user authentication, CRUD operations on job postings, and scheduling interviews.
- Static files (JS, CSS) and templates serve the UI, dictating how users interact with the system.
- Additional specialized modules (like resume_parser.py and mlmodel.py) are integrated into the backend logic to perform specific tasks such as parsing candidate details, data extraction, and prediction-based functionalities.

##### Architectural patterns and design principles
- The overall structure follows the Model-View-Controller (or Model-Template-View) pattern typical of Django applications.
- There is a clear separation between the presentation layer (templates and static files), the business logic (views and specialized modules within recruitment_app), and the persistence layer (MySQL database).
- The use of distinct directories for different functionalities (core project vs. recruitment_app vs. static assets vs. templates) demonstrates modular design and separation of concerns.
- The integration of SQL database instructions from the README ensures that the application’s authentication and job management components are reinforced by a well-defined relational schema.

##### Technologies, frameworks, or libraries
- Django Framework for the backend.
- MySQL as the relational database.
- HTML, CSS, and JavaScript on the front end (with dedicated static files).
- Possibly external Python libraries for machine learning/data extraction (referenced by files like mlmodel.py and extract_textual_data.py).

##### Summary
- Inside the "Django Server", break it down into:
- Core Project Configuration (HireHelp with settings, asgi, wsgi, URLs).
- Recruitment App (with separate sub-modules such as interview_scheduler, resume_parser, mlmodel, extract_textual_data).
- Optionally, show detailed interactions such as the shift of data between specialized modules (for instance, how resume_parser ties into candidate application processing).

## Diagram (Mermaid)

```mermaid
flowchart TD
    A["Client Browser"]:::client
    A -->|"HTTP_Request"| B["Django Backend"]:::backend

    subgraph "Django Backend Internal"
        direction TB
        C["Core Project Configuration"]:::backend
        D["Recruitment Application Module"]:::backend
        C --> D
        subgraph "Recruitment App Modules"
            direction TB
            E["Resume Parser"]:::module
            F["ML Model"]:::module
            G["Textual Data Extraction"]:::module
            H["Interview Scheduler"]:::module
            D --> E
            D --> F
            D --> G
            D --> H
        end
    end

    B -->|"ORM_Operations"| I["MySQL Database"]:::database
    B -->|"Renders_Views"| J["Templates"]:::frontend
    B -->|"Serves_Assets"| K["Static Assets"]:::frontend
    J -->|"UI_Rendering"| A
    K --> A

    click C "https://github.com/atharvasingh312/hirehelp/tree/main/HireHelp/"
    click D "https://github.com/atharvasingh312/hirehelp/tree/main/recruitment_app/"
    click E "https://github.com/atharvasingh312/hirehelp/blob/main/recruitment_app/resume_parser.py"
    click F "https://github.com/atharvasingh312/hirehelp/blob/main/recruitment_app/mlmodel.py"
    click G "https://github.com/atharvasingh312/hirehelp/blob/main/recruitment_app/extract_textual_data.py"
    click H "https://github.com/atharvasingh312/hirehelp/blob/main/recruitment_app/interview_scheduler.py"
    click I "https://github.com/atharvasingh312/hirehelp/blob/main/HireHelp/settings.py"
    click K "https://github.com/atharvasingh312/hirehelp/tree/main/static/"
    click J "https://github.com/atharvasingh312/hirehelp/tree/main/templates/"

    classDef client fill:#ffcc00,stroke:#333,stroke-width:2px;
    classDef backend fill:#fdd,stroke:#333,stroke-width:2px;
    classDef module fill:#fcc,stroke:#333,stroke-width:2px;
    classDef database fill:#c9f,stroke:#333,stroke-width:2px;
    classDef frontend fill:#dfd,stroke:#333,stroke-width:2px;
```
