Skip to content

kAmmarah/HealthWellnessBuddy

Repository files navigation

HealthWellnessBuddy

Here is a professional, engaging, and emoji-enhanced README.md file for your HealthWellnessBuddy project that clearly explains the folder structure and setup process in simple steps.


# 🌿 HealthWellnessBuddy πŸ§˜β€β™€οΈπŸ€–

Welcome to **HealthWellnessBuddy** β€” your friendly AI-powered health and wellness companion!  
This app provides helpful guidance on health-related topics such as weight management, diet plans, medical issues, and more using an interactive Streamlit frontend and powerful backend tools. πŸ’ͺπŸ₯—πŸ’¬

---

## πŸ“ Project Structure Overview

Here's what each file and folder does:

HealthWellnessBuddy/ β”‚ β”œβ”€β”€ client/ # Frontend tools and assets (built with Vite, Tailwind, etc.) β”‚ β”œβ”€β”€ server/ # Backend logic (API, tools, agents) using OpenAI Agents SDK β”‚ β”œβ”€β”€ shared/ # Shared utilities and modules used by both frontend and backend β”‚ β”œβ”€β”€ streamlit_app.py # 🎨 Main Streamlit entry point (beautiful UI + emoji-rich assistant) β”‚ β”œβ”€β”€ mock_api.py # Fake/mock data used for testing or UI demos β”‚ β”œβ”€β”€ requirements.txt # 🐍 Python dependencies for Streamlit and backend β”‚ β”œβ”€β”€ package.json # πŸ“¦ Node.js project config for frontend (Vite, Tailwind) β”œβ”€β”€ package-lock.json # Dependency lock for reproducible installs β”‚ β”œβ”€β”€ tailwind.config.ts # πŸ’… TailwindCSS styling config β”œβ”€β”€ postcss.config.js # CSS post-processor config β”œβ”€β”€ tsconfig.json # TypeScript config for client-side code β”œβ”€β”€ vite.config.ts # Vite bundler config β”‚ β”œβ”€β”€ drizzle.config.ts # Database & ORM (Drizzle) setup config β”‚ β”œβ”€β”€ Dockerfile # 🐳 Docker image for frontend (Streamlit UI) β”œβ”€β”€ Dockerfile.api # 🐳 Docker image for backend (API) β”œβ”€β”€ docker-compose.yml # πŸ”§ Combines frontend + backend into one dev/test environment β”‚ β”œβ”€β”€ runtime.txt # Runtime version (for deployment platforms like Heroku) β”œβ”€β”€ Procfile # Heroku deployment process instructions β”‚ β”œβ”€β”€ components.json # Shared component metadata (used in building UI or agent logic) β”‚ β”œβ”€β”€ README_streamlit.md # Extra instructions or style guide for Streamlit app β”œβ”€β”€ replit.md # Setup steps for Replit environment β”‚ └── README.md # πŸ‘‹ You are here!


---

## πŸš€ How to Run This Project

### 1. πŸ“¦ Install Backend (Python) Requirements

```bash
pip install -r requirements.txt

2. πŸ’» Run the Streamlit App

streamlit run streamlit_app.py

This launches your health buddy in the browser! 🌐🧠


🐳 Optional: Run with Docker

To run both frontend and backend using Docker:

docker-compose up --build

This pulls dependencies and starts the entire app automatically.


🌐 Folder Setup Guide (How I Created It)

  1. Created project folder:

    mkdir HealthWellnessBuddy && cd HealthWellnessBuddy
  2. Frontend (client):

    npm create vite@latest client --template react-ts
    cd client && npm install
    npm install tailwindcss postcss autoprefixer
    npx tailwindcss init -p
  3. Backend (server):

    • Created server/ folder with tools and OpenAI agent modules.
    • Added API endpoints, tools, and models.
  4. Streamlit UI:

    • Built a beautiful app using streamlit_app.py
    • Included emojis 🌟, animated backgrounds, health assistant logo, and UI enhancements.
  5. Docker + Compose:

    • Added Dockerfile, Dockerfile.api, and docker-compose.yml.
  6. Deployment files:

    • Added Procfile, runtime.txt, replit.md, README_streamlit.md.

❀️ Features

βœ… AI-powered health planner βœ… Supports diet, fitness, wellness tips βœ… Beautiful UI with emojis, animated backgrounds βœ… Fully Dockerized (frontend + backend) βœ… Works in Replit and Heroku


🧠 Built With

  • 🧠 OpenAI Agents SDK – Custom tools + health prompts
  • 🎨 Streamlit – Beautiful frontend
  • βš›οΈ Vite + React + TailwindCSS – For modern UI components
  • 🐍 Python – Backend agents and logic
  • 🐳 Docker – Easy deployment
  • πŸ”— Drizzle ORM – (Optional) for data handling

πŸ‘©β€πŸ’» Made by Ammara Dawood

Empowering health with a touch of tech! ✨ 🌐 Portfolio | πŸ’– GitHub](#)


πŸŽ‰πŸ’» Enjoy full-stack HealthWellnessBuddy right on Replit – AI chat, stylish UI, and backend brains, all in one place! πŸš€πŸ§˜β€β™‚οΈπŸŒ·πŸ’»

About

πŸ§ πŸ’¬ HealthWellnessBuddy – Your AI-powered health assistant with a friendly UI, smart tools, and full-stack magic in Docker!

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors