# abelitoxdj/portal-escuela-normal architecture

> Architecture diagram of the GitHub repository abelitoxdj/portal-escuela-normal, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/abelitoxdj/portal-escuela-normal
- Repository: https://github.com/abelitoxdj/portal-escuela-normal

## Overview

Portal Académico is a role-based school portal for students, guardians, and administrators. Users sign in, then view academic and school information or manage records through the web interface and REST API; the server enforces sessions and role/CSRF checks and persists data in MySQL. The README also documents password recovery by optional SMTP. Unsampled modules are included where the README or source index establishes their role, but links are limited to relationships visible in excerpts or explicitly documented.

Main entry points: [`server/index.js`](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/index.js) (Express app and sessions), [`server/routes/auth.js`](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/routes/auth.js) (Authentication routes), [`server/routes/api.js`](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/routes/api.js) (Student and school API), [`server/routes/admin.js`](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/routes/admin.js) (Administration API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Web interface"]
  node_login_ui["Login and recovery UI<br/>[login.js]"]
  node_portal_ui["Portal interface<br/>[app.js]"]
  node_portal_page["Portal page<br/>[index.html]"]
  node_login_page["Login page<br/>[login.html]"]
end

subgraph group_server["Application server"]
  node_server_entry["Express app and sessions<br/>[index.js]"]
  node_auth_routes["Authentication routes<br/>[auth.js]"]
  node_access["Session and CSRF checks<br/>[auth.js]"]
end

subgraph group_school["School operations"]
  node_school_api["Student and school API<br/>[api.js]"]
  node_admin_api["Administration API<br/>[admin.js]"]
  node_academic_views["Academic records and schedule<br/>[api.js]"]
  node_school_admin["School record management<br/>[admin.js]"]
end

subgraph group_data["Persistence and messaging"]
  node_mysql_pool["MySQL connection pool<br/>[db.js]"]
  node_recovery_mail["Recovery email sender<br/>[mailer.js]"]
end

node_users(("Students, guardians, admins"))
node_mysql[("MySQL / MariaDB")]
node_smtp["SMTP service"]

node_users -->|"opens"| node_login_page
node_server_entry -->|"serves"| node_login_page
node_server_entry -->|"serves after login"| node_portal_page
node_login_page -.->|"loads script"| node_login_ui
node_portal_page -.->|"loads script"| node_portal_ui
node_login_ui -->|"posts credentials"| node_auth_routes
node_portal_ui -->|"requests school data"| node_school_api
node_portal_ui -->|"submits admin changes"| node_admin_api
node_server_entry -->|"mounts routes"| node_auth_routes
node_server_entry -->|"mounts routes"| node_admin_api
node_server_entry -->|"mounts API"| node_school_api
node_server_entry -->|"uses CSRF check"| node_access
node_auth_routes -->|"uses auth checks"| node_access
node_admin_api -->|"uses role checks"| node_access
node_school_api -->|"uses login checks"| node_access
node_auth_routes -->|"queries users"| node_mysql_pool
node_school_api -->|"queries school records"| node_mysql_pool
node_admin_api -->|"manages records"| node_mysql_pool
node_server_entry -->|"configures session store"| node_mysql_pool
node_mysql_pool -->|"connects to"| node_mysql
node_auth_routes -->|"sends recovery email"| node_recovery_mail
node_recovery_mail -->|"sends via SMTP"| node_smtp
node_school_api -->|"serves records"| node_academic_views
node_admin_api -->|"manages records"| node_school_admin

click node_login_ui "https://github.com/abelitoxdj/portal-escuela-normal/blob/main/public/login.js"
click node_portal_ui "https://github.com/abelitoxdj/portal-escuela-normal/blob/main/public/app.js"
click node_portal_page "https://github.com/abelitoxdj/portal-escuela-normal/blob/main/public/index.html"
click node_login_page "https://github.com/abelitoxdj/portal-escuela-normal/blob/main/public/login.html"
click node_server_entry "https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/index.js"
click node_auth_routes "https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/routes/auth.js"
click node_access "https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/middleware/auth.js"
click node_school_api "https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/routes/api.js"
click node_admin_api "https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/routes/admin.js"
click node_academic_views "https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/routes/api.js"
click node_school_admin "https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/routes/admin.js"
click node_mysql_pool "https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/db.js"
click node_recovery_mail "https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/mailer.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_login_ui,node_portal_ui,node_portal_page,node_login_page toneBlue
class node_server_entry,node_auth_routes,node_access,node_mysql toneAmber
class node_school_api,node_admin_api,node_academic_views,node_school_admin toneMint
class node_mysql_pool,node_recovery_mail toneRose
class node_users,node_smtp toneIndigo
```

## Components

### Web interface

- [Login and recovery UI](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/public/login.js): `public/login.js`
- [Portal interface](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/public/app.js): `public/app.js`
- [Portal page](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/public/index.html): `public/index.html`
- [Login page](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/public/login.html): `public/login.html`

### Application server

- [Express app and sessions](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/index.js): `server/index.js`
- [Authentication routes](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/routes/auth.js): `server/routes/auth.js`
- [Session and CSRF checks](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/middleware/auth.js): `server/middleware/auth.js`

### School operations

- [Student and school API](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/routes/api.js): `server/routes/api.js`
- [Administration API](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/routes/admin.js): `server/routes/admin.js`
- [Academic records and schedule](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/routes/api.js): `server/routes/api.js`
- [School record management](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/routes/admin.js): `server/routes/admin.js`

### Persistence and messaging

- [MySQL connection pool](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/db.js): `server/db.js`
- [Recovery email sender](https://github.com/abelitoxdj/portal-escuela-normal/blob/main/server/mailer.js): `server/mailer.js`

### Other components

- **Students, guardians, admins**
- **MySQL / MariaDB**
- **SMTP service**

## Connections

- Students, guardians, admins → Login page: opens
- Express app and sessions → Login page: serves (evidence: `server/index.js`)
- Express app and sessions → Portal page: serves after login (evidence: `server/index.js`)
- Login page → Login and recovery UI: loads script
- Portal page → Portal interface: loads script
- Login and recovery UI → Authentication routes: posts credentials (evidence: `public/login.js`)
- Portal interface → Student and school API: requests school data (evidence: `public/app.js`)
- Portal interface → Administration API: submits admin changes (evidence: `public/app.js`)
- Express app and sessions → Authentication routes: mounts routes (evidence: `server/index.js`)
- Express app and sessions → Administration API: mounts routes (evidence: `server/index.js`)
- Express app and sessions → Student and school API: mounts API (evidence: `server/index.js`)
- Express app and sessions → Session and CSRF checks: uses CSRF check (evidence: `server/index.js`)
- Authentication routes → Session and CSRF checks: uses auth checks (evidence: `server/routes/auth.js`)
- Administration API → Session and CSRF checks: uses role checks (evidence: `server/routes/admin.js`)
- Student and school API → Session and CSRF checks: uses login checks (evidence: `server/routes/api.js`)
- Authentication routes → MySQL connection pool: queries users (evidence: `server/routes/auth.js`)
- Student and school API → MySQL connection pool: queries school records (evidence: `server/routes/api.js`)
- Administration API → MySQL connection pool: manages records (evidence: `server/routes/admin.js`)
- Express app and sessions → MySQL connection pool: configures session store (evidence: `server/index.js`)
- MySQL connection pool → MySQL / MariaDB: connects to (evidence: `server/db.js`)
- Authentication routes → Recovery email sender: sends recovery email (evidence: `server/routes/auth.js`)
- Recovery email sender → SMTP service: sends via SMTP (evidence: `server/mailer.js`)
- Student and school API → Academic records and schedule: serves records (evidence: `server/routes/api.js`)
- Administration API → School record management: manages records (evidence: `server/routes/admin.js`)
