https://github.com/22p31a0512/wexa_ai
A modern, scalable helpdesk system with ticketing, knowledge base, real-time notifications, and optional AI-powered automation for smarter customer support.
https://github.com/22p31a0512/wexa_ai
chatbot customer-experience customer-support-assistant docker expressjs fastapi microservices mongodb nodejs react realtime-notifications support-automation ticketing-system vite
Last synced: 7 days ago
JSON representation
A modern, scalable helpdesk system with ticketing, knowledge base, real-time notifications, and optional AI-powered automation for smarter customer support.
- Host: GitHub
- URL: https://github.com/22p31a0512/wexa_ai
- Owner: 22P31A0512
- Created: 2025-08-22T18:28:04.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-08-23T06:28:40.000Z (about 2 months ago)
- Last Synced: 2025-09-20T10:28:55.776Z (26 days ago)
- Topics: chatbot, customer-experience, customer-support-assistant, docker, expressjs, fastapi, microservices, mongodb, nodejs, react, realtime-notifications, support-automation, ticketing-system, vite
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 Helpdesk Project
A **modern, scalable, and AI-powered Helpdesk System** designed for enterprises, startups, and support teams.
This solution provides a seamless **ticketing system, real-time communication, knowledge base, and AI-driven assistance** to optimize customer support operations.
---
## 🏗 Architecture Overview
The system follows a **modular, service-oriented architecture** with three primary components:
1. **Backend (API Layer)** – Built with **Node.js & Express**, powered by **MongoDB** for flexible and scalable data storage.
* Handles authentication, ticket workflows, user management, and knowledge base APIs.
* Implements **role-based access control (RBAC)** for secure multi-user environments.
2. **Frontend (Client Layer)** – A **React + Vite** web application delivering a clean, responsive, and interactive user interface.
* Optimized for performance with modern bundling tools.
* Provides intuitive dashboards for **agents, admins, and end-users**.
3. **Agent Worker (AI Layer - Optional)** – A **Python FastAPI microservice** for AI-driven automation.
* **Ticket classification** using NLP.
* **Smart reply suggestions** and response drafting.
* Can be extended with **OpenAI/GPT or custom ML models**.
---
## ⚡ Key Features
* **🔐 Authentication & Authorization**
* Secure JWT-based login and signup
* Role-based access (Admin, Agent, Customer)
* **🎫 Ticket Management System**
* Create, assign, track, and close tickets
* Priority & SLA management
* Comment threads and attachments support
* **📚 Knowledge Base**
* Create and manage help articles
* Searchable knowledge system for customers
* Markdown editor for article creation
* **🤖 AI Capabilities (Optional)**
* Automated ticket categorization
* Suggested responses for agents
* Sentiment analysis on customer messages
* **🔔 Real-Time Notifications**
* WebSocket-based live updates
* New ticket alerts, status changes, and agent mentions
* **📊 Admin Dashboard**
* Ticket volume analytics
* Agent performance monitoring
* SLA compliance reports
* **☁️ Cloud & Container Support**
* Docker-based deployment
* Scalable with Kubernetes or Docker Swarm
* CI/CD ready
---
## 🛠 Development Setup
### Prerequisites
* **Node.js** v18+
* **Python** 3.8+
* **MongoDB** (local or cloud e.g., MongoDB Atlas)
* **Docker** (optional for containerized deployment)
### Setup Instructions
#### 1. Backend Setup
```bash
cd backend
npm install
npm run dev
```
#### 2. Frontend Setup
```bash
cd frontend
npm install
npm run dev
```
#### 3. Agent Worker Setup (Optional)
```bash
cd agent-worker
pip install -r requirements.txt
python -m app.main
```
#### 4. Docker Setup (Full System)
```bash
cd config
docker-compose up -d
```
---
## 📂 Project Structure
```
helpdesk-project/
├── backend/ # Node.js Express API
│ ├── src/ # API source code
│ ├── tests/ # Unit & integration tests
│ └── docs/ # API Documentation
├── frontend/ # React Vite application
│ ├── src/ # React components & pages
│ └── public/ # Static assets
├── agent-worker/ # Python FastAPI AI service
├── config/ # Docker, env files, deployment configs
└── scripts/ # Database seeding & maintenance scripts
```
---
## 📖 API Documentation
Detailed API docs available in:
👉 [Backend README](./backend/README.md)
👉 Swagger UI available at `/api/docs` when running the backend service.
---
## 🚀 Future Enhancements
* **AI-powered chatbots** integrated with the knowledge base
* **Multi-channel support** (Email, WhatsApp, Slack, MS Teams)
* **Customizable workflows** for different industries
* **Plugin architecture** for third-party integrations (CRM, ERP, Slack, etc.)
---
## 🤝 Contributing
We welcome contributions from the community!
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
---
## 🎯 Why This Project?
* Built with **modern technologies** ensuring performance & scalability
* **AI integration** for smarter customer support
* **Flexible deployment** – works on local, cloud, or containerized environments
* Designed for **real-world support teams** handling large ticket volumes