Skip to content

Latest commit

 

History

History
115 lines (83 loc) · 4.25 KB

README.md

File metadata and controls

115 lines (83 loc) · 4.25 KB

Heal Well 🏥

Heal Well

Welcome to the Heal Well project repository! Heal Well is a hospital management platform designed to improve healthcare services, offering an efficient user experience for both patients and staff. This platform is ideal for hospitals in New Delhi, streamlining processes like appointment management, blog creation, and staff scheduling.

Table of Contents 📚

Features 🌟

User-Friendly Interface

  • Simplified navigation with dedicated pages like About, Careers, Doctors, Partners, Services, Testimonials, and Volunteers.

Admin Panel

  • Manage key hospital data, including appointments, blogs, and doctor schedules, through an intuitive admin interface.

Responsive Design

  • Optimized for all devices, providing a seamless experience across desktops, tablets, and smartphones, using Tailwind CSS for a modern look.

API Endpoints

  • API routes to manage core hospital features such as appointments, blogs, partners, and volunteers, with easy integration into the platform.

Dynamic Content

  • Flexible, customizable blog pages with unique styles for each post.

Health Chatbot with AI Integration

  • A new ChatComponent provides real-time interaction for health queries with:
    • Website-specific Context: Tailors responses to "Heal Well" capabilities.
    • Query Processing: Routes queries for relevant information on health or website specifics.

Technologies Used ⚙️

  • Framework: Next.js ⚛️
  • Styling: Tailwind CSS & ShadCN 🌈
  • UI Components: Lucide React Icons & custom UI components 🖼️
  • Backend: Node.js (via Next.js API routes) 🖥️
  • Database: MongoDB 🗄️
  • Deployment: Vercel 🚀
  • Email Integration: Gmail (via OAuth2 authentication) 📧
  • AI Services: Google Generative AI (gemini-1.5-flash model)

The platform supports automated email notifications, such as appointment confirmations , using Gmail's SMTP server. The email service is set up through Google Cloud Console with OAuth2 authentication to ensure secure communication between the app and Gmail.

Installation 💻

To set up the project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/akshay0611/HealWell.git
cd HealWell

  2. Install dependencies:

    npm install

  3. Run the application:

    npm run dev

  4. Access the application:

Usage 🛠️

  • For End Users:
    Navigate through the website using the main navigation menu. Access different hospital services, view doctors' profiles, learn about career opportunities, and read patient testimonials.

  • For Admin Users:
    Admin users can access the admin panel where they can manage appointments, blogs, and doctor time-tables through the dedicated admin navigation interface.

Contributing 🤝

We welcome contributions! To contribute:

  1. Fork the repository 🍴.
  2. Create a new branch: 
    git checkout -b feature/your-feature-name
  3. Commit your changes: 
    git commit -m "Add your message here"
  4. Push to the branch: 
    git push origin feature/your-feature-name
  5. Submit a pull request 🚀.

License 📄

This project is licensed under the MIT License. See the LICENSE file for more details.

Contact 📞

For any questions, feedback, or inquiries:

Thank you for contributing to and using Heal Well! 🎉