Skip to content
Muralidhara Bhat K S edited this page Mar 13, 2025 · 3 revisions

🏠 Chatter Box Application - Home Page

Welcome to the Chatter Box Application GitHub Wiki! πŸš€

Chatter Box is a full-stack chat application that allows users to chat in real-time and interact with AI models like GPT, Grok, Bedrock, and Claude. It is designed to be fast, scalable, and AI-powered, making conversations smarter and more interactive.


πŸ“Œ Features

βœ… Real-time Chat using WebSockets
βœ… AI Model Integration (GPT-3, Grok, Bedrock, Claude)
βœ… User Authentication (JWT-based Login/Signup)
βœ… Chat History & Message Storage
βœ… File Sharing & Media Support
βœ… AI Response Caching for Performance
βœ… Secure & Scalable Architecture


πŸ“œ Table of Contents

πŸ“Œ Roadmap – Development Plan & Milestones
πŸ“Œ Project Setup – How to install & run the project
πŸ“Œ Architecture – System design & components overview
πŸ“Œ API Documentation – REST & WebSocket API details
πŸ“Œ Deployment Guide – How to deploy on AWS, Heroku, etc.
πŸ“Œ Testing & Debugging – How to test the application


πŸ“¦ Tech Stack

Technology Usage
React.js Frontend UI
Spring Boot Backend API & WebSockets
PostgreSQL / MongoDB Database for users & messages
WebSockets (STOMP) Real-time chat
AI APIs (GPT, Grok, Bedrock, Claude) AI Model integration
JWT Authentication Secure user login
Docker & Kubernetes Containerization & Scaling
AWS / DigitalOcean Deployment

πŸš€ Getting Started

To set up the project locally, follow these steps:

πŸ”§ Prerequisites

  • Node.js & npm installed
  • Java 17+ installed
  • PostgreSQL or MongoDB set up

πŸ’» Clone the Repository

git clone https://github.com/SlenderShield/ChatterBox.git
cd ChatterBox

πŸ“Œ Run Backend (Spring Boot)

cd backend
mvn spring-boot:run

🌐 Run Frontend (React)

cd frontend
npm install
npm start

For full setup details, check the Project Setup Guide.


πŸ”— Contributing

Want to contribute? Check out our Contributing Guide for guidelines! 🎯


πŸ“© Contact & Support

If you have any questions or feature requests, feel free to open an Issue or reach out to the maintainers!