# stark-2006/ai-faq-assistant architecture

> Architecture diagram of the GitHub repository stark-2006/ai-faq-assistant, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/stark-2006/ai-faq-assistant
- Repository: https://github.com/stark-2006/ai-faq-assistant

## Overview

This is an Express API for an AI-assisted FAQ service. Clients register or log in, then can browse, search, create, update, and delete FAQs; authenticated users can also request generated answers or FAQ pairs. Routes apply validation and authentication before dispatching to controllers, which use MongoDB-backed models or the Gemini service. The source index and excerpts establish these calls; database connection details and some middleware behavior were not sampled.

Main entry points: [`AI FAQ - Copy/CODE/src/app.js`](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/app.js) (Express app), [`AI FAQ - Copy/CODE/src/routes/authRoutes.js`](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/routes/authRoutes.js) (Auth routes), [`AI FAQ - Copy/CODE/src/routes/faqRoutes.js`](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/routes/faqRoutes.js) (FAQ routes), [`AI FAQ - Copy/CODE/src/routes/aiRoutes.js`](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/routes/aiRoutes.js) (AI routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API routing"]
  node_authroutes["Auth routes<br/>[authRoutes.js]"]
  node_faqroutes["FAQ routes<br/>[faqRoutes.js]"]
  node_airoutes["AI routes<br/>[aiRoutes.js]"]
  node_validation["Request validation"]
end

subgraph group_identity["User identity"]
  node_authguard["JWT protection<br/>[authMiddleware.js]"]
  node_authcontroller["Account operations<br/>[authController.js]"]
  node_user[("User records<br/>[User.js]")]
  node_tokenhelper["Token helper<br/>[helpers.js]"]
end

subgraph group_faq["FAQ management"]
  node_faqcontroller["FAQ operations<br/>[faqController.js]"]
  node_faqmodel[("FAQ records<br/>[FAQ.js]")]
end

subgraph group_ai["AI generation"]
  node_aicontroller["AI operations<br/>[aiController.js]"]
  node_gemini["Gemini API<br/>[geminiService.js]"]
end

subgraph group_runtime["Runtime infrastructure"]
  node_server["HTTP server<br/>[server.js]"]
  node_app["Express app<br/>[app.js]"]
  node_errors["Error handler<br/>[errorMiddleware.js]"]
  node_dbconnect["DB connector<br/>[db.js]"]
  node_database[("MongoDB")]
end

node_client(("API client"))

node_client -->|"sends requests"| node_server
node_server -->|"connects database"| node_dbconnect
node_server -->|"serves"| node_app
node_app -->|"mounts"| node_authroutes
node_app -->|"mounts"| node_faqroutes
node_app -->|"mounts"| node_airoutes
node_app -->|"handles errors"| node_errors
node_authroutes -->|"dispatches"| node_authcontroller
node_authroutes -->|"validates"| node_validation
node_authroutes -->|"protects profile"| node_authguard
node_faqroutes -->|"dispatches"| node_faqcontroller
node_faqroutes -->|"validates"| node_validation
node_faqroutes -->|"protects writes"| node_authguard
node_airoutes -->|"dispatches"| node_aicontroller
node_airoutes -->|"validates"| node_validation
node_airoutes -->|"protects requests"| node_authguard
node_authcontroller -->|"reads and writes"| node_user
node_authcontroller -->|"generates token"| node_tokenhelper
node_authguard -->|"loads user"| node_user
node_faqcontroller -->|"reads and writes"| node_faqmodel
node_aicontroller -->|"requests generation"| node_gemini
node_dbconnect -.->|"connects"| node_database

click node_server "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/server.js"
click node_app "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/app.js"
click node_errors "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/middleware/errorMiddleware.js"
click node_dbconnect "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/config/db.js"
click node_authroutes "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/routes/authRoutes.js"
click node_faqroutes "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/routes/faqRoutes.js"
click node_airoutes "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/routes/aiRoutes.js"
click node_validation "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/middleware/validationMiddleware.js"
click node_authguard "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/middleware/authMiddleware.js"
click node_authcontroller "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/controllers/authController.js"
click node_user "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/models/User.js"
click node_tokenhelper "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/utils/helpers.js"
click node_faqcontroller "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/controllers/faqController.js"
click node_faqmodel "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/models/FAQ.js"
click node_aicontroller "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/controllers/aiController.js"
click node_gemini "https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/services/geminiService.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_authroutes,node_faqroutes,node_airoutes,node_validation,node_client toneBlue
class node_authguard,node_authcontroller,node_user,node_tokenhelper toneAmber
class node_faqcontroller,node_faqmodel toneMint
class node_aicontroller,node_gemini toneRose
class node_server,node_app,node_errors,node_dbconnect,node_database toneIndigo
```

## Components

### API routing

- [Auth routes](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/routes/authRoutes.js): `AI FAQ - Copy/CODE/src/routes/authRoutes.js`
- [FAQ routes](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/routes/faqRoutes.js): `AI FAQ - Copy/CODE/src/routes/faqRoutes.js`
- [AI routes](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/routes/aiRoutes.js): `AI FAQ - Copy/CODE/src/routes/aiRoutes.js`
- [Request validation](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/middleware/validationMiddleware.js): `AI FAQ - Copy/CODE/src/middleware/validationMiddleware.js`

### User identity

- [JWT protection](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/middleware/authMiddleware.js): `AI FAQ - Copy/CODE/src/middleware/authMiddleware.js`
- [Account operations](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/controllers/authController.js): `AI FAQ - Copy/CODE/src/controllers/authController.js`
- [User records](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/models/User.js): `AI FAQ - Copy/CODE/src/models/User.js`
- [Token helper](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/utils/helpers.js): `AI FAQ - Copy/CODE/src/utils/helpers.js`

### FAQ management

- [FAQ operations](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/controllers/faqController.js): `AI FAQ - Copy/CODE/src/controllers/faqController.js`
- [FAQ records](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/models/FAQ.js): `AI FAQ - Copy/CODE/src/models/FAQ.js`

### AI generation

- [AI operations](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/controllers/aiController.js): `AI FAQ - Copy/CODE/src/controllers/aiController.js`
- [Gemini API](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/services/geminiService.js): `AI FAQ - Copy/CODE/src/services/geminiService.js`

### Runtime infrastructure

- [HTTP server](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/server.js): `AI FAQ - Copy/CODE/src/server.js`
- [Express app](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/app.js): `AI FAQ - Copy/CODE/src/app.js`
- [Error handler](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/middleware/errorMiddleware.js): `AI FAQ - Copy/CODE/src/middleware/errorMiddleware.js`
- [DB connector](https://github.com/stark-2006/ai-faq-assistant/blob/main/AI%20FAQ%20-%20Copy/CODE/src/config/db.js): `AI FAQ - Copy/CODE/src/config/db.js`
- **MongoDB**

### Other components

- **API client**

## Connections

- API client → HTTP server: sends requests
- HTTP server → DB connector: connects database (evidence: `AI FAQ - Copy/CODE/src/server.js`)
- HTTP server → Express app: serves (evidence: `AI FAQ - Copy/CODE/src/server.js`)
- Express app → Auth routes: mounts (evidence: `AI FAQ - Copy/CODE/src/app.js`)
- Express app → FAQ routes: mounts (evidence: `AI FAQ - Copy/CODE/src/app.js`)
- Express app → AI routes: mounts (evidence: `AI FAQ - Copy/CODE/src/app.js`)
- Express app → Error handler: handles errors (evidence: `AI FAQ - Copy/CODE/src/app.js`)
- Auth routes → Account operations: dispatches (evidence: `AI FAQ - Copy/CODE/src/routes/authRoutes.js`)
- Auth routes → Request validation: validates (evidence: `AI FAQ - Copy/CODE/src/routes/authRoutes.js`)
- Auth routes → JWT protection: protects profile (evidence: `AI FAQ - Copy/CODE/src/routes/authRoutes.js`)
- FAQ routes → FAQ operations: dispatches (evidence: `AI FAQ - Copy/CODE/src/routes/faqRoutes.js`)
- FAQ routes → Request validation: validates (evidence: `AI FAQ - Copy/CODE/src/routes/faqRoutes.js`)
- FAQ routes → JWT protection: protects writes (evidence: `AI FAQ - Copy/CODE/src/routes/faqRoutes.js`)
- AI routes → AI operations: dispatches (evidence: `AI FAQ - Copy/CODE/src/routes/aiRoutes.js`)
- AI routes → Request validation: validates (evidence: `AI FAQ - Copy/CODE/src/routes/aiRoutes.js`)
- AI routes → JWT protection: protects requests (evidence: `AI FAQ - Copy/CODE/src/routes/aiRoutes.js`)
- Account operations → User records: reads and writes (evidence: `AI FAQ - Copy/CODE/src/controllers/authController.js`)
- Account operations → Token helper: generates token (evidence: `AI FAQ - Copy/CODE/src/controllers/authController.js`)
- JWT protection → User records: loads user (evidence: `AI FAQ - Copy/CODE/src/middleware/authMiddleware.js`)
- FAQ operations → FAQ records: reads and writes (evidence: `AI FAQ - Copy/CODE/src/controllers/faqController.js`)
- AI operations → Gemini API: requests generation (evidence: `AI FAQ - Copy/CODE/src/controllers/aiController.js`)
- DB connector → MongoDB: connects
