Skip to content

IviweBooi/chillbuddy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

15 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

ChillBuddy 🌟

Your AI-Powered Mental Health Companion

ChillBuddy is an innovative mental health support application that combines AI-driven conversations, gamification, and comprehensive resources to provide accessible mental health support. Built for the South African Intervarsity Hackathon 2025, ChillBuddy aims to make mental health care more approachable and engaging for young adults.


πŸš€ Features

  • πŸ€– AI Chat Support: Intelligent conversational AI that provides empathetic mental health support
  • πŸ“Š Mood Tracking: Visual mood tracking with insights and patterns
  • πŸ† Gamification: Achievement system with badges and progress tracking
  • πŸ“š Resource Library: Curated mental health resources and crisis support
  • 🎯 Goal Setting: Personal wellness goals with progress monitoring
  • πŸ”’ Privacy-First: Secure, confidential conversations with data protection
  • πŸ“± Responsive Design: Works seamlessly across desktop and mobile devices

πŸ“‚ Repository Structure

β”œβ”€β”€ assets/                 # Project assets and media
β”œβ”€β”€ demo/                   # Demo videos and presentations
β”œβ”€β”€ docs/                   # Project documentation
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ backend/           # Python Flask backend
β”‚   β”‚   β”œβ”€β”€ app.py         # Main application server
β”‚   β”‚   β”œβ”€β”€ conversation.py # AI conversation logic
β”‚   β”‚   β”œβ”€β”€ gamification.py # Achievement system
β”‚   β”‚   β”œβ”€β”€ resources.py   # Mental health resources
β”‚   β”‚   └── models/        # Data models
β”‚   └── frontend/          # HTML/CSS/JS frontend
β”‚       β”œβ”€β”€ index.html     # Main application interface
β”‚       β”œβ”€β”€ css/           # Styling and themes
β”‚       └── js/            # Client-side functionality
β”œβ”€β”€ scripts/               # Utility and deployment scripts
└── vendor/                # Third-party dependencies

πŸ› οΈ Technology Stack

Backend:

  • Python 3.8+
  • Flask web framework
  • OpenAI GPT API for conversational AI
  • SQLite for data persistence
  • JSON-based configuration

Frontend:

  • Vanilla HTML5, CSS3, JavaScript
  • Responsive CSS Grid and Flexbox
  • Modern ES6+ JavaScript features
  • CSS custom properties for theming

Development:

  • Git version control
  • Docker containerization support
  • Cross-platform compatibility

πŸš€ Quick Start

  1. Clone the repository

    git clone https://github.com/yourusername/chillbuddy.git
    cd chillbuddy
  2. Set up the backend

    cd src/backend
    pip install -r requirements.txt
    python app.py
  3. Launch the frontend

    cd src/frontend
    python -m http.server 8000
  4. Open your browser Navigate to http://localhost:8000

For detailed setup instructions, see SETUP.md.

πŸ“– Documentation

🎯 Core Components

πŸ€– AI Conversation Engine

  • Empathetic AI: Trained responses for mental health support
  • Context Awareness: Maintains conversation history and user preferences
  • Safety Filters: Built-in crisis detection and appropriate responses
  • Personalization: Adapts to individual user communication styles

πŸ“Š Mood & Progress Tracking

  • Daily Mood Logging: Simple, intuitive mood entry system
  • Visual Analytics: Charts and graphs showing mood patterns
  • Insight Generation: AI-powered observations about mental health trends
  • Goal Progress: Track wellness objectives and milestones

πŸ† Gamification System

  • Achievement Badges: Unlock rewards for consistent engagement
  • Progress Levels: Advance through wellness journey stages
  • Sharing Features: Celebrate achievements with community
  • Motivation Tracking: Maintain engagement through positive reinforcement

πŸ“š Resource Library

  • Curated Content: Professional mental health resources
  • Crisis Support: Emergency contacts and immediate help options
  • Educational Materials: Articles, videos, and self-help guides
  • Local Resources: South African mental health services and contacts

πŸ”’ Privacy & Security

ChillBuddy prioritizes user privacy and data security:

  • Local Data Storage: Sensitive information stored locally when possible
  • Encrypted Communications: All API communications use HTTPS
  • Minimal Data Collection: Only essential data is collected and processed
  • User Control: Users can delete their data at any time
  • Compliance: Follows best practices for mental health data handling

🌍 Accessibility & Inclusivity

  • Multi-language Support: Designed for South African linguistic diversity
  • Cultural Sensitivity: Culturally appropriate mental health approaches
  • Accessibility Features: Screen reader compatible, keyboard navigation
  • Mobile-First Design: Optimized for smartphones and tablets
  • Low-Bandwidth Friendly: Efficient loading for various internet speeds

πŸš€ Getting Started

Prerequisites

  • Python 3.8 or higher
  • Modern web browser (Chrome, Firefox, Safari, Edge)
  • Internet connection for AI features
  • OpenAI API key (for full functionality)

Installation

  1. Clone and navigate to the project

    git clone https://github.com/yourusername/chillbuddy.git
    cd chillbuddy
  2. Install backend dependencies

    cd src/backend
    pip install -r requirements.txt
  3. Configure environment variables

    cp config.py.example config.py
    # Edit config.py with your API keys
  4. Start the application

    # Terminal 1: Start backend
    python app.py
    
    # Terminal 2: Start frontend server
    cd ../frontend
    python -m http.server 8000
  5. Access the application Open your browser to http://localhost:8000

Docker Deployment (Optional)

docker build -t chillbuddy .
docker run -p 8000:8000 chillbuddy

πŸ§ͺ Testing

Run the test suite to ensure everything is working correctly:

cd src/backend
python run_tests.py

πŸ“Š Project Status

  • βœ… Core AI conversation system
  • βœ… Mood tracking functionality
  • βœ… Gamification and achievements
  • βœ… Resource library
  • βœ… Responsive UI design
  • βœ… Crisis support integration
  • πŸ”„ Advanced analytics (in progress)
  • πŸ”„ Mobile app version (planned)

🀝 Contributing

We welcome contributions to ChillBuddy! Please read our contributing guidelines and feel free to submit issues and pull requests.

πŸ“„ License

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

πŸ™Œ Acknowledgments

  • South African Intervarsity Hackathon 2025 organizers
  • Open source community for tools and libraries
  • My AI coding assistant, Trae

Built with ❀️ for mental health awareness and support

ChillBuddy - Making mental health support accessible, engaging, and effective for everyone.

About

ChillBuddy is an innovative mental health support application that combines AI-driven conversations, gamification, and comprehensive resources to provide accessible mental health support.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors