How stark-2006/ai-faq-assistant works
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: app.js Express app · authRoutes.js Auth routes · faqRoutes.js FAQ routes · aiRoutes.js AI routes
Components 18
API routing
- Auth routes
AI FAQ - Copy/CODE/src/routes/authRoutes.js - FAQ routes
AI FAQ - Copy/CODE/src/routes/faqRoutes.js - AI routes
AI FAQ - Copy/CODE/src/routes/aiRoutes.js - Request validation
AI FAQ - Copy/CODE/src/middleware/validationMiddleware.js
User identity
- JWT protection
AI FAQ - Copy/CODE/src/middleware/authMiddleware.js - Account operations
AI FAQ - Copy/CODE/src/controllers/authController.js - User records
AI FAQ - Copy/CODE/src/models/User.js - Token helper
AI FAQ - Copy/CODE/src/utils/helpers.js
FAQ management
- FAQ operations
AI FAQ - Copy/CODE/src/controllers/faqController.js - FAQ records
AI FAQ - Copy/CODE/src/models/FAQ.js
AI generation
- AI operations
AI FAQ - Copy/CODE/src/controllers/aiController.js - Gemini API
AI FAQ - Copy/CODE/src/services/geminiService.js
Runtime infrastructure
- HTTP server
AI FAQ - Copy/CODE/src/server.js - Express app
AI FAQ - Copy/CODE/src/app.js - Error handler
AI FAQ - Copy/CODE/src/middleware/errorMiddleware.js - DB connector
AI FAQ - Copy/CODE/src/config/db.js - MongoDB
Other components
- API client
Connections 22
- API client → HTTP server: sends requests
- HTTP server → DB connector: connects database
AI FAQ - Copy/CODE/src/server.js - HTTP server → Express app: serves
AI FAQ - Copy/CODE/src/server.js - Express app → Auth routes: mounts
AI FAQ - Copy/CODE/src/app.js - Express app → FAQ routes: mounts
AI FAQ - Copy/CODE/src/app.js - Express app → AI routes: mounts
AI FAQ - Copy/CODE/src/app.js - Express app → Error handler: handles errors
AI FAQ - Copy/CODE/src/app.js - Auth routes → Account operations: dispatches
AI FAQ - Copy/CODE/src/routes/authRoutes.js - Auth routes → Request validation: validates
AI FAQ - Copy/CODE/src/routes/authRoutes.js - Auth routes → JWT protection: protects profile
AI FAQ - Copy/CODE/src/routes/authRoutes.js - FAQ routes → FAQ operations: dispatches
AI FAQ - Copy/CODE/src/routes/faqRoutes.js - FAQ routes → Request validation: validates
AI FAQ - Copy/CODE/src/routes/faqRoutes.js - FAQ routes → JWT protection: protects writes
AI FAQ - Copy/CODE/src/routes/faqRoutes.js - AI routes → AI operations: dispatches
AI FAQ - Copy/CODE/src/routes/aiRoutes.js - AI routes → Request validation: validates
AI FAQ - Copy/CODE/src/routes/aiRoutes.js - AI routes → JWT protection: protects requests
AI FAQ - Copy/CODE/src/routes/aiRoutes.js - Account operations → User records: reads and writes
AI FAQ - Copy/CODE/src/controllers/authController.js - Account operations → Token helper: generates token
AI FAQ - Copy/CODE/src/controllers/authController.js - JWT protection → User records: loads user
AI FAQ - Copy/CODE/src/middleware/authMiddleware.js - FAQ operations → FAQ records: reads and writes
AI FAQ - Copy/CODE/src/controllers/faqController.js - AI operations → Gemini API: requests generation
AI FAQ - Copy/CODE/src/controllers/aiController.js - DB connector → MongoDB: connects