How p-thavamani/complaint-management-system works
Project type and purpose
• This is a full-stack web application: a Complaint Management System with AI-powered chatbot integration, ticketing, real-time tracking and admin dashboard.
• Frontend: React.js single-page application (SPA) using Hooks, Context API, TailwindCSS, Chart.js, React Router.
• Backend: Flask RESTful API with JWT authentication, scheduled tasks, and integrations (Google Speech-to-Text, YOLOv8 image analysis, Google Gemini).
File structure
• Top-level directories:
• frontend/ – React code, build config, public assets
• backend/ – Flask API modules, utilities, environment config, startup scripts
• backend/api/ contains endpoint modules (auth, users, complaints, chatbot, rewards, feedback, admin).
• backend/utils/ contains middleware, model downloads, notifications, scheduled-task helpers.
• frontend/src/components/, pages/, context/, services/ indicate UI components, routes, global state (AuthContext), and API client (axios).
• Configuration files: .env, package.json, requirements.txt, config-overrides.js, tailwind.config.js.
README insights
• Describes core and unique features, tech stack, DB (MongoDB Atlas), environment variables, setup steps.
• Mentions high-level architecture: frontend ↔ API ↔ database + external AI/image services.
a. Main components
• User-facing UI: React SPA (components, pages)
• API Layer: Flask RESTful app (app.py, run.py, api/*)
• Database: MongoDB Atlas (collections for users, complaints, tickets, rewards, feedback)
• Authentication: JWT handling via auth.py + auth_middleware
• Scheduled Tasks: scheduled_tasks.py for notifications, escalations, cleanup
• External Services:
– Google Speech-to-Text API (voice→text)
– YOLOv8 model server or library (image analysis)
– Google Gemini API (chatbot intelligence)
– Notification channels (email/SMS via notifications util)
b. Relationships and interactions
• React SPA sends HTTP/HTTPS requests to Flask API
• API verifies JWT, routes to appropriate api/*.py handlers
• Handlers perform CRUD on MongoDB via Flask drivers
• For voice/image complaints: handlers call Google Speech or YOLO modules in utils
• For chatbot sessions: api/chatbot.py communicates with Google Gemini
• Scheduled tasks trigger background workflows (daily summary, escalations)
• API emits real-time updates via WebSockets or polling (if implemented)
c. Architectural patterns and principles
• Layered architecture: Presentation (UI) → API (controllers) → Services/Utils → Data Layer
• Modular design: separate modules for each domain (auth, complaints, rewards)
• Middleware for cross-cutting concerns (auth_middleware)
• External integration abstraction in utils/download_model, test_speech, notifications
d. Key technologies
• React.js, TailwindCSS, Chart.js, React Router
• Flask, Flask-RESTful, PyMongo
• JWT (pyjwt), dotenv for config
• MongoDB Atlas
• Google Speech-to-Text API, YOLOv8, Google Gemini API