Skip to content

Lokesh1028/ayush-herb-hub

Repository files navigation

AYUSH Herb Hub - Virtual Herbal Garden

Table of Contents

List of Tables

Table No. Description Page
2.1 Core Features Overview 4
2.2 Technical Stack Components 5
3.1 Plant Data Model Structure 7
3.2 Database Schema 8
4.1 UI Component Library 9
6.1 Development Milestones 13
7.1 Risk Assessment Matrix 15

List of Diagrams

Diagram No. Description Page
2.1 System Architecture Overview 4
3.1 Entity Relationship Diagram 7
3.2 Class Diagram 8
4.1 Component Hierarchy 9
4.2 User Flow Diagram 10
5.1 Security Architecture 11
6.1 Development Timeline 13

Abstract

The AYUSH Herb Hub is a comprehensive Virtual Herbal Garden web application designed to provide an interactive, educational, and immersive experience for users exploring medicinal plants used in AYUSH (Ayurveda, Yoga & Naturopathy, Unani, Siddha, and Homeopathy) systems of medicine.

Built using modern web technologies including React 18, TypeScript, and Tailwind CSS, the application features a responsive design with advanced search capabilities, detailed plant information, and an intuitive user interface. The platform showcases over 50 medicinal plants with comprehensive details including botanical names, medicinal uses, parts used, ailments treated, and identification tips.

Key features include:

  • Interactive Plant Catalog: Browse through a comprehensive collection of medicinal plants with high-quality images and detailed information
  • Advanced Search: Dual search functionality allowing users to search by plant names or specific ailments
  • Responsive Design: Optimized for desktop, tablet, and mobile devices
  • Educational Content: Detailed information about AYUSH systems and traditional medicine practices
  • Modern UI/UX: Clean, accessible interface with dark mode support

The application serves as a digital bridge, making traditional herbal knowledge accessible to students, researchers, educators, and anyone interested in learning about medicinal plants. By leveraging modern web technologies, the Virtual Herbal Garden ensures scalability, maintainability, and an excellent user experience while preserving and disseminating valuable traditional medicine knowledge.

Quick Start

Prerequisites

  • Node.js 18+
  • npm or yarn package manager

Installation

git clone <repository-url>
cd ayush-herb-hub
npm install
npm run dev

Tech Stack

  • Frontend: React 18, TypeScript, Vite
  • Styling: Tailwind CSS, shadcn/ui components
  • Routing: React Router DOM
  • State Management: React Query
  • Icons: Lucide React
  • Build Tool: Vite

Contributing

Please read our Contributing Guidelines before submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For questions and support, please contact the development team or open an issue in this repository.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages