From c1d03b71b46c9dada2484f55d09851221735fd0a Mon Sep 17 00:00:00 2001 From: Swapnil Verma Date: Fri, 6 Feb 2026 11:54:25 +0530 Subject: [PATCH 1/2] readme update --- README.md | 222 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 143 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index 51da2b9..ed75877 100644 --- a/README.md +++ b/README.md @@ -1,128 +1,192 @@ -πŸ₯ Baymax – Smart Appointment Booking System -Baymax is an intelligent, full-stack clinic management web application that simplifies appointment booking using AI, voice commands, and Google integrations. Designed for front desk use, it ensures a seamless experience for booking and managing patient appointments. +πŸ₯ Baymax β€” Smart AI Appointment Booking System -## login demo credentials -username: aaa@aaa.com -password: 1234567 +Baymax is an intelligent clinic management web application that automates front-desk appointment booking using voice commands, AI parsing, and Google integrations. -## πŸš€ Quick Start +It acts like a virtual receptionist β€” staff can simply speak the request and Baymax schedules the appointment, updates the doctor’s calendar, and sends confirmation emails automatically. -1. Clone the repository: -```bash -git clone https://github.com/your-username/baymax.git -``` +Built as a full-stack system focusing on real-world usability, automation, and accessibility. -2. Install dependencies: -```bash -cd baymax -npm install -``` +✨ Demo Login +Email: aaa@aaa.com +Password: 1234567 -3. Start the development server: -```bash -npm start -``` +🧠 What Makes Baymax Different? + +Traditional systems β†’ manual typing β†’ slow +Baymax β†’ speak β†’ understand β†’ schedule β†’ notify + +The system converts natural speech like: + +β€œBook an appointment for Rahul tomorrow at 3 PM with Dr. Sharma” + +into a structured appointment using AI-based parsing and validation. + +πŸš€ Features +πŸŽ™οΈ AI Voice Booking + +Speech β†’ text using Web Speech API + +Natural language parsing + +Intelligent date & time detection + +Slot validation before booking + +πŸ“… Google Calendar Sync -4. Open your browser and visit `http://localhost:3000` to access the application. +Automatically creates doctor events +Prevents overlapping appointments -πŸ“Œ Key Features -πŸŽ™οΈ AI-Powered Voice Appointment Booking -Book appointments using speech with automatic transcription and intelligent slot mapping. +Real-time schedule visibility -πŸ“… Google Calendar Integration -Automatically syncs booked appointments with the doctor's Google Calendar. +πŸ“§ Automatic Email Notifications -πŸ“§ Gmail Notifications -Sends confirmation emails to patients and doctors via Gmail API. +Confirmation mail to patient -πŸ’‘ User-Friendly Interface -Built with React and Tailwind CSS for a clean, responsive UI. +Reminder mail to doctor + +Powered by Gmail API + +πŸ” Secure Authentication + +JWT-based login sessions + +bcrypt password hashing + +πŸ’» Clean UI/UX + +Responsive interface + +Built for front-desk operators + +Minimal training required πŸ› οΈ Tech Stack -πŸ”Ή Frontend +Frontend + React +Tailwind CSS + Axios -Web Speech API (Speech Recognition) +Web Speech API -Tailwind CSS +Backend -πŸ”Ή Backend Node.js -Express +Express.js -Mongoose +MongoDB (Mongoose) -JWT (Authentication) +JWT Authentication -bcrypt (Password hashing) +bcrypt -πŸ”Ή Database -MongoDB Atlas (Cloud) +Cloud & Integrations -πŸ”— API Endpoints -Method URL Description -POST /api/auth/login Login and generate JWT -POST /api/appointment/create Create a new appointment -GET /api/appointment/list Retrieve all appointments +Google Calendar API -βš™οΈ Installation -bash -Copy -Edit -git clone https://github.com/suvxn/baymax.git -cd baymax -πŸ”§ Environment Variables -Create a .env file in the server/ directory with the following keys: +Gmail API + +MongoDB Atlas +πŸ—οΈ System Architecture +User Speech + ↓ +Speech Recognition + ↓ +AI Parser + ↓ +Backend Validation + ↓ +Database Storage + ↓ +Google Calendar + Gmail Notification -▢️ Running the Application -Start the backend server: +βš™οΈ Local Setup +1️⃣ Clone the repository +git clone https://github.com/suvxn/baymax.git +cd baymax -bash -Copy -Edit +2️⃣ Setup Backend cd server npm install npm start -Start the frontend: -bash -Copy -Edit -cd frontend + +Backend runs on: http://localhost:5000 + +3️⃣ Setup Frontend +cd ../frontend npm install npm run dev -Client: http://localhost:5173 -Server: http://localhost:5000 -πŸ“€ Gmail & Calendar Integration -Requires Google OAuth setup. The app uses Gmail API and Google Calendar API for: -Sending email confirmations to patients and doctors. +Frontend runs on: http://localhost:5173 -Automatically adding appointments to Google Calendar. +πŸ”‘ Environment Variables -πŸ€– AI Voice Booking -Uses the Web Speech API for speech recognition. +Create a .env file inside server/ -Recognizes keywords like "book appointment for tomorrow at 3 PM with Dr. Smith". +PORT=5000 +MONGO_URI=your_mongodb_connection +JWT_SECRET=your_secret -AI parses and validates input before creating the booking. +GOOGLE_CLIENT_ID=your_client_id +GOOGLE_CLIENT_SECRET=your_secret +GOOGLE_REDIRECT_URI=your_redirect +GOOGLE_REFRESH_TOKEN=your_refresh_token -πŸ‘₯ Contributing -We welcome contributions! +πŸ“‘ API Endpoints +Method Endpoint Description +POST /api/auth/login Login & get token +POST /api/appointment/create Create appointment +GET /api/appointment/list Fetch appointments +πŸ€– Voice Command Examples -Fork the repository +Try saying: -Create a feature branch +β€œBook appointment for Aman tomorrow at 5 PM” + +β€œSchedule patient Ravi on Monday morning” + +β€œAppointment for Neha at 2:30 PM with Dr. Mehta” + +πŸ“¬ Google Integrations + +Baymax connects with: + +Google Calendar β†’ Adds appointment events + +Gmail API β†’ Sends confirmation emails -Submit a pull request +Requires Google OAuth credentials setup -Issues and feature suggestions are also appreciated. +πŸ‘¨β€πŸ’» Contributing + +Contributions are welcome! + +Fork the repo + +Create a feature branch + +Open a Pull Request πŸ“„ License -This project is licensed under the MIT License. + +MIT License + +🌟 Future Improvements + +WhatsApp reminders + +Doctor dashboard analytics + +Multi-clinic support + +AI no-show prediction + +Voice support in regional languages From 460d8d47f85d8f853e79f2c85d74c1fb5b93378e Mon Sep 17 00:00:00 2001 From: Swapnil Verma Date: Fri, 6 Feb 2026 11:57:11 +0530 Subject: [PATCH 2/2] Update README.md --- README.md | 227 +++++++++++++++++++++++------------------------------- 1 file changed, 97 insertions(+), 130 deletions(-) diff --git a/README.md b/README.md index ed75877..46a9ca6 100644 --- a/README.md +++ b/README.md @@ -1,136 +1,106 @@ -πŸ₯ Baymax β€” Smart AI Appointment Booking System +# Baymax β€” Smart AI Appointment Booking System Baymax is an intelligent clinic management web application that automates front-desk appointment booking using voice commands, AI parsing, and Google integrations. -It acts like a virtual receptionist β€” staff can simply speak the request and Baymax schedules the appointment, updates the doctor’s calendar, and sends confirmation emails automatically. +It works like a virtual receptionist β€” staff can speak the request and Baymax schedules the appointment, updates the doctor's calendar, and sends confirmation emails automatically. -Built as a full-stack system focusing on real-world usability, automation, and accessibility. +--- -✨ Demo Login +## Demo Login +``` Email: aaa@aaa.com Password: 1234567 +``` -🧠 What Makes Baymax Different? +--- -Traditional systems β†’ manual typing β†’ slow -Baymax β†’ speak β†’ understand β†’ schedule β†’ notify +## Features -The system converts natural speech like: +### AI Voice Booking +- Speech to text using Web Speech API +- Natural language understanding +- Automatic date and time detection +- Slot validation before booking -β€œBook an appointment for Rahul tomorrow at 3 PM with Dr. Sharma” +### Google Calendar Integration +- Automatically creates doctor events +- Prevents overlapping appointments -into a structured appointment using AI-based parsing and validation. +### Email Notifications +- Confirmation mail to patient +- Reminder mail to doctor +- Powered by Gmail API -πŸš€ Features -πŸŽ™οΈ AI Voice Booking +### Secure Authentication +- JWT based sessions +- bcrypt password hashing -Speech β†’ text using Web Speech API +### User Interface +- Clean responsive UI +- Designed for front desk operators -Natural language parsing +--- -Intelligent date & time detection +## Tech Stack -Slot validation before booking +### Frontend +- React +- Tailwind CSS +- Axios +- Web Speech API -πŸ“… Google Calendar Sync +### Backend +- Node.js +- Express.js +- MongoDB (Mongoose) +- JWT +- bcrypt -Automatically creates doctor events +### Integrations +- Google Calendar API +- Gmail API +- MongoDB Atlas -Prevents overlapping appointments +--- -Real-time schedule visibility +## Architecture +``` +Speech β†’ Text β†’ AI Parser β†’ Backend Validation β†’ Database β†’ Calendar + Email +``` -πŸ“§ Automatic Email Notifications +--- -Confirmation mail to patient +## Local Setup -Reminder mail to doctor - -Powered by Gmail API - -πŸ” Secure Authentication - -JWT-based login sessions - -bcrypt password hashing - -πŸ’» Clean UI/UX - -Responsive interface - -Built for front-desk operators - -Minimal training required - -πŸ› οΈ Tech Stack -Frontend - -React - -Tailwind CSS - -Axios - -Web Speech API - -Backend - -Node.js - -Express.js - -MongoDB (Mongoose) - -JWT Authentication - -bcrypt - -Cloud & Integrations - -Google Calendar API - -Gmail API - -MongoDB Atlas - -πŸ—οΈ System Architecture -User Speech - ↓ -Speech Recognition - ↓ -AI Parser - ↓ -Backend Validation - ↓ -Database Storage - ↓ -Google Calendar + Gmail Notification - -βš™οΈ Local Setup -1️⃣ Clone the repository +### 1. Clone Repository +```bash git clone https://github.com/suvxn/baymax.git cd baymax +``` -2️⃣ Setup Backend +### 2. Backend Setup +```bash cd server npm install npm start +``` +Runs on: http://localhost:5000 - -Backend runs on: http://localhost:5000 - -3️⃣ Setup Frontend +### 3. Frontend Setup +```bash cd ../frontend npm install npm run dev +``` +Runs on: http://localhost:5173 +--- -Frontend runs on: http://localhost:5173 - -πŸ”‘ Environment Variables +## Environment Variables -Create a .env file inside server/ +Create `.env` inside `server/` +``` PORT=5000 MONGO_URI=your_mongodb_connection JWT_SECRET=your_secret @@ -139,54 +109,51 @@ GOOGLE_CLIENT_ID=your_client_id GOOGLE_CLIENT_SECRET=your_secret GOOGLE_REDIRECT_URI=your_redirect GOOGLE_REFRESH_TOKEN=your_refresh_token +``` -πŸ“‘ API Endpoints -Method Endpoint Description -POST /api/auth/login Login & get token -POST /api/appointment/create Create appointment -GET /api/appointment/list Fetch appointments -πŸ€– Voice Command Examples +--- -Try saying: +## API Endpoints -β€œBook appointment for Aman tomorrow at 5 PM” +| Method | Endpoint | Description | +|------|------|------| +| POST | /api/auth/login | Login and get token | +| POST | /api/appointment/create | Create appointment | +| GET | /api/appointment/list | Fetch appointments | -β€œSchedule patient Ravi on Monday morning” +--- -β€œAppointment for Neha at 2:30 PM with Dr. Mehta” +## Example Voice Commands +- Book appointment for Rahul tomorrow at 3 PM +- Schedule patient Aman on Monday morning +- Appointment for Neha at 2:30 PM with Dr. Mehta -πŸ“¬ Google Integrations +--- +## Google Integration Baymax connects with: +- Google Calendar β†’ adds appointment events +- Gmail API β†’ sends confirmation emails -Google Calendar β†’ Adds appointment events +Requires Google OAuth credentials. -Gmail API β†’ Sends confirmation emails +--- -Requires Google OAuth credentials setup +## Contributing +1. Fork the repository +2. Create a feature branch +3. Open a pull request -πŸ‘¨β€πŸ’» Contributing - -Contributions are welcome! - -Fork the repo - -Create a feature branch - -Open a Pull Request - -πŸ“„ License +--- +## License MIT License -🌟 Future Improvements - -WhatsApp reminders - -Doctor dashboard analytics - -Multi-clinic support - -AI no-show prediction +--- -Voice support in regional languages +## Future Improvements +- WhatsApp reminders +- Doctor analytics dashboard +- Multi clinic support +- AI no-show prediction +- Regional language voice support