Skip to content

Update README.md #643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Adii0906 merged 1 commit into from
Jan 26, 2026
Merged

Update README.md #643

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 54 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,47 @@ The vision for TalkHeal is to address these challenges by providing accessible,

In essence, TalkHeal aims to destigmatize mental health, promote self-awareness, and make evidence-based support accessible to everyone. By integrating compassionate AI with a comprehensive toolkit of wellness resources, TalkHeal seeks to become a trusted companion on the journey toward a healthier and more balanced life.

## 🚀 Live Demo
---

## 🏗️ Architecture & Logic Flow
To help contributors understand how **TalkHeal** integrates AI, databases, and wellness tools, here is a breakdown of our internal logic.

### 🔄 User Interaction Lifecycle
This sequence shows how your message is processed through the chosen AI personality and logged for your mood history.

```mermaid
sequenceDiagram
participant User
participant Streamlit_UI
participant Tone_Selector
participant Gemini_API
participant SQLite_DB

User->>Streamlit_UI: Enters message
Streamlit_UI->>Tone_Selector: Fetch selected Tone (e.g., Wise Friend)
Tone_Selector->>Gemini_API: Prompt + Context + Tone Instructions
Gemini_API-->>Streamlit_UI: Empathetic Response
Streamlit_UI->>SQLite_DB: Log Session/Mood
```

### 🧠 Intelligence Hub Routing
TalkHeal isn't just a chatbot; it's a wellness engine. Depending on your mood input, the system routes you to specific therapeutic tools.

```mermaid
graph TD
A[User Logins] --> B{Mood Input}
B -- Negative/Stressed --> C[Coping Tips & Breathing]
B -- High Energy --> D[Yoga Recommendation Engine]
B -- Overwhelmed --> E[Emergency Help / Crisis Page]
C --> F[SQLite Journal Entry]
D --> F
```

---

## 🚀 Live Demo
Experience TalkHeal live here:

👉 [![**TalkHeal**](https://img.shields.io/badge/View-Live%20Demo-magenta?style=for-the-badge)](https://TalkHeal.app/)

<div align="center">
Expand All @@ -61,6 +99,8 @@ Experience TalkHeal live here:
<br>
</div>

---

## ✨ Features
<div align="center">
<img src="https://user-images.githubusercontent.com/74038190/212284158-e840e285-664b-44d7-b79b-e264b5e54825.gif" alt="Animated features showcase divider" width="400">
Expand Down Expand Up @@ -185,6 +225,8 @@ This will create:

**Note**: Database files (`.db`) are automatically ignored by git to prevent conflicts and protect user data.

---

## 📺 Video Explanation

For a detailed walkthrough of TalkHeal's features and how to use them, check out this video:
Expand Down Expand Up @@ -273,12 +315,10 @@ TalkHeal/
└── users.db # Database for user authentication

```

</details>

---


## 🛠️ Technologies Used

![Python](https://img.shields.io/badge/Python-20232A?style=for-the-badge&logo=python&logoColor=61DAFB)
Expand All @@ -300,29 +340,24 @@ TalkHeal/
> Clone and run locally using Python and Streamlit.

1. **Clone the repository:**

```bash
git clone https://github.com/eccentriccoder01/TalkHeal.git
cd TalkHeal
```

2. **Install dependencies:**

```bash
pip install -r requirements.txt
```

> **Having installation issues?** Check our [Installation Troubleshooting Guide](INSTALLATION_TROUBLESHOOTING.md) for solutions to common problems like timeout errors, slow downloads, and network issues.

3. **Set up API key:**
Go to your Streamlit [Secrets Settings](https://streamlit.io/cloud) and add:

```toml
GEMINI_API_KEY = "YOUR_GOOGLE_GEMINI_API_KEY"
```

4. **Set up OAuth (Optional but Recommended):**

4. **Set up OAuth (Optional but Recommended):**
Create a `.env` file in the TalkHeal directory:

```env
Expand All @@ -345,13 +380,11 @@ TalkHeal/
For detailed OAuth setup instructions, see [OAUTH_SETUP.md](OAUTH_SETUP.md)

5. **Run the app:**

```bash
streamlit run TalkHeal.py
```

6. **Test OAuth setup (Optional):**

```bash
python test_oauth.py
```
Expand All @@ -361,6 +394,8 @@ TalkHeal/
## Issue Creation ✴
Report bugs and issues or propose improvements through our GitHub repository.

---

## Contribution Guidelines 📑

<div align="center">
Expand All @@ -375,14 +410,16 @@ Report bugs and issues or propose improvements through our GitHub repository.
- Add Screenshots and updated website links to help us understand what changes is all about.

- Check the [CONTRIBUTING.md](CONTRIBUTING.md) for detailed steps...
## Contributing is fun🧡

### Contributing is fun🧡

We welcome all contributions and suggestions!
Whether it's a new feature, design improvement, or a bug fix — your voice matters 💜

Your insights are invaluable to us. Reach out to us team for any inquiries, feedback, or concerns.

---

## 👥 Contributors

Thanks to these wonderful people for contributing 💖
Expand All @@ -401,10 +438,14 @@ Thanks to these wonderful people for contributing 💖
</a>
</p>

---

## 📄 License

This project is open-source and available under the [MIT License](LICENSE).

---

## 📞 Contact

Developed by [Eccentric Explorer](https://eccentriccoder01.github.io/Me)
Expand Down