Merge pull request #66 from TejasriMasina/project_structure

Project structure Improved

Author: CharithaReddy18

Build/temp

@@ -1,90 +1,103 @@
-Here’s a set of **Contribution Guidelines** tailored for your open-source project:
+# Contributing to AI-health-chatbot
 
----
+Thank you for considering contributing to AI-health-chatbot! 🎉
+We welcome contributions of all types — bug fixes, feature implementations, documentation improvements, and feedback.
 
-# Contribution Guidelines
+-> These guidelines are here to make the process smooth and collaborative for everyone.
 
-Thank you for considering contributing to **Blok**! We welcome contributions of all types, including bug fixes, feature implementations, documentation improvements, and feedback. These guidelines are here to make the process clear and smooth for everyone.
+## 🚀 How to Contribute
 
----
+### 1. Discuss Your Idea
 
-## How to Contribute
+* Before starting work on a major change, please open an **issue** in the repository.
+* Use the issue template (if available) or describe your idea clearly.
 
-### 1. **Discuss Your Idea**
-- Before starting work on a major change, please open an issue in the repository.
-- Use the **#ideas-and-feedback** channel in our [Discord community](https://discord.gg/QXhHzw7azs) for discussions.
+### 2. Fork and Clone
 
-### 2. **Fork and Clone**
-- Fork the repository to your GitHub account.
-- Clone the forked repository to your local machine.
+* Fork this repository to your GitHub account.
+* Clone the forked repository to your local machine:
 
 ```bash
-git clone https://github.com/YOUR_USERNAME/blok.git
-cd blok
+git clone https://github.com/CharithaReddy18/AI-health-chatbot.git
+cd AI-health-chatbot
 ```
 
-### 3. **Set Up Your Environment**
-- Follow the instructions in the `README.md` to set up your development environment.
-- Run tests to ensure everything works as expected.
-
-### 4. **Work on Your Contribution**
-- Create a new branch for your work:
-  ```bash
-  git checkout -b feature/your-feature-name
-  ```
-- Follow the coding style and conventions used in the project.
-- Write clear, concise, and well-documented code.
-- If adding a new feature, include relevant tests.
-
-### 5. **Commit Your Changes**
-- Write meaningful commit messages:
-  ```bash
-  git commit -m "Add: Feature description"
-  ```
-- Push your changes to your fork:
-  ```bash
-  git push origin feature/your-feature-name
-  ```
-
-### 6. **Submit a Pull Request**
-- Open a pull request from your branch to the `main` branch of the original repository.
-- Use the pull request template (if available) to provide details about your changes.
-- Ensure that all automated tests pass before submission.
-
----
-
-## Code Style and Standards
-- Use ESLint to ensure code consistency.
-- Adhere to the project's architectural patterns and modular design principles.
-- Avoid introducing unnecessary dependencies.
-
----
-
-## Reporting Issues
-If you encounter a bug or have a feature request:
-1. Check the Issues to ensure it hasn’t been reported.
+### 3. Set Up Your Environment
+
+* Check the ['README.md'](README.md) for setup instructions.
+* Install requirements based on requirements.txt.
+
+### 4. Work on Your Contribution
+
+* Create a new branch for your work:
+
+```bash
+git checkout -b feature/your-feature-name
+```
+
+* Follow the coding style and conventions used in the project.
+* Write clear, well-documented code.
+* Add tests if applicable.
+
+### 5. Commit Your Changes
+
+* Use meaningful commit messages:
+
+```bash
+git commit -m "Add: Short description of your change"
+```
+
+* Push your changes:
+
+```bash
+git push origin feature/your-feature-name
+```
+
+### 6. Submit a Pull Request
+
+* Open a Pull Request (PR) to the `main` branch of this repository.
+* Fill out the PR template (if available).
+* Make sure all checks/tests pass before requesting review.
+
+
+## 🧩 Code Style and Standards
+
+* Use ESLint / Prettier (if configured) for consistent formatting.
+* Follow naming conventions and keep code modular.
+* Avoid introducing unnecessary requirements.
+
+
+## 🐛 Reporting Issues
+
+If you find a bug or have a feature request:
+
+1. Check the existing issues first.
 2. Open a new issue with:
-   - A clear and descriptive title.
-   - Steps to reproduce the issue (if applicable).
-   - Expected and actual behavior.
 
----
+   * A clear and descriptive title
+   * Steps to reproduce (if it’s a bug)
+   * Expected vs. actual behavior
+
+
+## 📖 Documentation Contributions
+
+* Update relevant Markdown files (`README.md`, `docs/`) for docs-related changes.
+* Keep writing clear, concise, and beginner-friendly.
+
+
+## 🤝 Community and Conduct
+
+* Be respectful and collaborative in all interactions.
+* Follow the project’s [Code of Conduct](CODE_OF_CONDUCT.md).
+
 
-## Documentation Contributions
-- For documentation edits, update the relevant markdown files in the `docs/` directory.
-- Follow a clear and concise writing style.
+## ❓ Need Help?
 
----
+If you have any questions:
 
-## Community and Conduct
-- Be respectful and collaborative when interacting with others.
-- Adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md).
+* Open an issue with the `question` label.
+* Tag project maintainers for clarification.
 
----
 
-## Need Help?
-If you have questions or need help, feel free to:
-- Join our [Discord community](https://discord.gg/QXhHzw7azs).
-- Open an issue with the `question` label.
+We’re excited to collaborate with you and improve **AI-health-chatbot** together! 💡
 
-We’re excited to collaborate with you and improve **Blok** together!

CONTRIBUTING.md

@@ -133,6 +133,63 @@ MediBot follows a modern, microservices-inspired architecture:
 
 ## 📂 Project Structure
 
+
+```plaintext
+AI-HEALTH-CHATBOT/
+├── backend/                    # FastAPI Backend Application
+│   ├── app/
+│   │   ├── Medical_DataBase/   # Stores the FAISS vector index for the RAG model
+│   │   │   ├── index.faiss
+│   │   │   └── index.pkl
+│   │   ├── models/             # Pydantic schemas for data validation (schemas.py)
+│   │   ├── routers/            # Defines the API endpoints (e.g., /chat, /disease)
+│   │   │   ├── chat.py
+│   │   │   ├── disease.py
+│   │   │   └── health.py
+│   │   ├── services/           # Contains the core business logic for all features
+│   │   │   ├── disease_predictor.py
+│   │   │   ├── health_info.py
+│   │   │   ├── medical_agent.py # Manages the core RAG pipeline and LLM interaction
+│   │   │   └── symptom_checker.py
+│   │   ├── utils/              # Utility and helper functions
+│   │   ├── config.py           # Handles configuration and environment variables
+│   │   └── main.py             # The main entry point to launch the FastAPI server
+│   ├── data/                   # Directory for raw data files like CSVs
+│   └── requirements.txt        # A list of all Python dependencies
+│
+├── client/                     # React Frontend Application
+│   ├── public/                 # Contains static assets like the main index.html and icons
+│   ├── src/
+│   │   ├── api/                # Functions for making HTTP requests to the backend
+│   │   ├── assets/             # Stores local assets like images, fonts, and CSS
+│   │   ├── components/         # Reusable React components (e.g., ChatWindow, Button)
+│   │   ├── pages/              # Components representing entire pages or views
+│   │   ├── App.jsx             # The main root component of the application
+│   │   └── main.jsx            # The entry point for the React application
+│   ├── package.json            # Lists Node.js dependencies and project scripts
+│   └── vite.config.js          # Configuration file for the Vite build tool
+│
+└── README.md                   # You are here!
+```
+
+
+# AI Health Chatbot
+
+Medibot is a Streamlit-based AI health assistant that provides symptom checking, health guidance, and doctor recommendations using NLP and Retrieval-Augmented Generation (RAG).
+
+---
+
+## 🚀 New Feature: NLP Enhancement (Multilingual Support)
+
+- Added translation pipeline (English ↔ Hindi, Marathi, Telugu).
+- Integrated multilingual embeddings with FAISS.
+- Added language selector in Streamlit UI.
+- Ensured responses maintain medical safety disclaimer.
+
+### How to Run:
+1. `pip install -r requirements.txt`
+2. `streamlit run app/WellnessResourceHub.py`
+
 ```
 AI-health-chatbot/
 ├── 📁 backend/                          # Backend API and services
@@ -275,6 +332,7 @@ cd backend
 docker-compose up  # No --build flag needed unless dependencies change
 ```
 
+
 **Frontend**: 
 ```
 cd client
@@ -309,8 +367,15 @@ The application uses Pydantic for configuration management. Key settings include
 
 ## 🧪 Testing the System
 
+
+```env
+GROQ_API_KEY="YOUR_KEY_HERE"
+HUGGINGFACE_API_KEY="YOUR_KEY_HERE"
+```
+
 ### 🔍 **Basic Functionality Test**
 
+
 1. **Start the Application** (both backend and frontend)
 
 2. **Navigate to the Symptom Checker** in your browser
@@ -515,6 +580,10 @@ The MIT License allows for:
 
 ## 👥 Contributors
 
+
+
+->Thank you once again to all our contributors who has contributed to **AI-health-chatbot!** Your efforts are truly appreciated. 💖👏
+
 ### 🧑‍💼 **Project Admin**
 <table>
 <tr>
@@ -530,6 +599,7 @@ The MIT License allows for:
 </tr>
 </table>
 
+
 ### 👨‍🏫 **Mentors (GSSoC '25)**
 <table>
 <tr>