# gargdivyansh1/educaseindia_backendassignment architecture

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

- Interactive diagram: https://gitdiagram.com/gargdivyansh1/educaseindia_backendassignment
- Repository: https://github.com/gargdivyansh1/educaseindia_backendassignment

## Overview

##### Project Type and Purpose
- This is a backend REST API service (Node.js + Express) for managing “School” records in a MySQL database.
- Primary functions: add a school and list schools sorted by proximity to a given coordinate.

##### File Structure Analysis
- index.js: application entry point; boots Express, applies middleware, mounts routes.
- config/db.js: database connection configuration using MySQL.
- routes/schoolRoutes.js: maps HTTP endpoints to controller methods.
- controllers/schoolController.js: contains request handlers, calls validation, business logic, and DB layer.
- validations/schoolValidation.js: request‐payload schema checks.
- utils/distance.js: contains the algorithm for calculating geospatial distance.
- sql/create_school_db.sql: DDL for setting up the MySQL “schools” table.

##### Key Technologies and Patterns
- Express.js for HTTP routing and middleware pipeline.
- MVC‐style layering (Routes → Controllers → Data Layer).
- MySQL relational database accessed via a DB client in config/db.js.
- Utility module for shared logic (distance calculation).
- Hosted on Railway (external PaaS).

##### Main Components
a. Client (e.g., Postman or frontend) sending HTTP requests.
b. Express API Server:
- HTTP Listener (index.js)
- Router Layer (schoolRoutes.js)
- Controller Layer (schoolController.js)
- Validation Layer (schoolValidation.js)
- Utility Layer (distance.js)
c. MySQL Database (configured via config/db.js; schema defined in sql/create_school_db.sql).
d. External Hosting Platform (Railway).

##### Interactions and Data Flow
1. Client issues HTTP request to `/api/addSchool` or `/api/listSchools`.
2. Express Listener forwards to appropriate Route.
3. Route invokes Validation middleware.
4. If valid, Controller executes:
- For POST: inserts new record into MySQL.
- For GET: queries all schools, passes results to distance util, sorts by computed distance.
5. Controller sends JSON response back to Client.
6. MySQL serves as persistent store; connection pooled in config/db.js.

##### Architectural Patterns and Principles
- Layered architecture: separate concerns (routing, validation, business logic, data access).
- Single responsibility per module.
- Reusable utility functions for cross‐cutting logic (distance).
- Externalize configuration (DB credentials, host) from code.

##### Detailed Checklist
- [ ] All modules labeled clearly (Routes, Controllers, Utils, Validation).
- [ ] Data flows annotated with HTTP methods and SQL operations.
- [ ] Connection pool or DB config represented in config/db.js.
- [ ] Utility function invocation for distance.
- [ ] Hosting environment boundary indicated.

## Diagram (Mermaid)

```mermaid
flowchart TD
    Client["Client (e.g., Postman)"]:::external

    subgraph "Railway PaaS"
        subgraph "Express API Server"
            HTTP["HTTP Listener<br/>(index.js)"]:::codeModule
            Routes["Router Layer<br/>(routes/schoolRoutes.js)"]:::codeModule
            Validation["Validation Layer<br/>(validations/schoolValidation.js)"]:::codeModule
            Controllers["Controller Layer<br/>(controllers/schoolController.js)"]:::codeModule
            Utils["Utility Layer<br/>(utils/distance.js)"]:::codeModule
            DBConfig["DB Config<br/>(config/db.js)"]:::codeModule
        end
        DB["MySQL Database"]:::db
        Schema["Schema DDL<br/>(sql/create_school_db.sql)"]:::db
    end

    Client -->|POST/GET /api/addSchool or /api/listSchools| HTTP
    HTTP -->|"mount routes"| Routes
    Routes -->|"payload validation"| Validation
    Validation -->|"validated request"| Controllers
    Controllers -->|"INSERT/SELECT schools"| DB
    Controllers -.->|"compute distance"| Utils
    Controllers -->|"HTTP JSON response"| Client
    DBConfig -->|"connection pool"| DB

    click HTTP "https://github.com/gargdivyansh1/educaseindia_backendassignment/blob/main/index.js"
    click Routes "https://github.com/gargdivyansh1/educaseindia_backendassignment/blob/main/routes/schoolRoutes.js"
    click Validation "https://github.com/gargdivyansh1/educaseindia_backendassignment/blob/main/validations/schoolValidation.js"
    click Controllers "https://github.com/gargdivyansh1/educaseindia_backendassignment/blob/main/controllers/schoolController.js"
    click Utils "https://github.com/gargdivyansh1/educaseindia_backendassignment/blob/main/utils/distance.js"
    click DBConfig "https://github.com/gargdivyansh1/educaseindia_backendassignment/blob/main/config/db.js"
    click Schema "https://github.com/gargdivyansh1/educaseindia_backendassignment/blob/main/sql/create_school_db.sql"

    classDef codeModule fill:#D6EAF8,stroke:#1B4F72,color:#1B2631;
    classDef db fill:#A9DFBF,stroke:#145A32,color:#1D8348;
    classDef external fill:#F9E79F,stroke:#B9770E,color:#7E5109;
```
