ChorePal App

A family-friendly mobile application that gamifies household chores with rewards, real-time tracking, and AI-powered voice task creation.

✨ Features

Core Functionality

• 👨‍👩‍👧‍👦 Family Management: Separate parent and child accounts with PIN-based child authentication
• ✅ Chore Assignment: Create, assign, and schedule chores with due dates and point values
• 🎮 Gamification: Point-based reward system to motivate children
• 📊 Progress Tracking: Visual statistics and progress monitoring
• 🏆 Reward System: Customizable rewards that children can redeem with earned points

Advanced Features

• 🎤 Voice Task Creation: Create chores using natural language voice commands powered by AI
• 📸 Photo Proof System: Children submit photos of completed chores for parent verification
• ⚡ Real-time Updates: Instant notifications and status updates via Firebase
• 📅 Calendar Integration: Schedule and track chores with calendar view
• 🔔 Push Notifications: Get notified when chores are assigned, completed, or photos need approval

🛠️ Tech Stack

Frontend:

• SwiftUI for native iOS development
• Custom UI components with glass-card effects and animations
• Firebase Authentication & Firestore for backend
• AVFoundation for voice recording and speech synthesis

Backend:

• Node.js/Express server for voice processing
• OpenAI Whisper API for speech-to-text
• Google AI Studio (Gemini) for natural language understanding
• Firebase for real-time data synchronization

🚀 Getting Started

Prerequisites

• Xcode 14.0 or later
• iOS 18.2 or later
• Node.js 18+ (for voice server)
• Firebase account

Installation

1. Clone the repository

   git clone https://github.com/akalyankar012/IT-Capstone_ChorePal_App.git
   cd IT-Capstone_ChorePal_App/chorepal\ prototype

2. iOS App Setup

   • Open chorepal prototype.xcodeproj in Xcode
   • Configure Firebase:
     • Add your GoogleService-Info.plist to the project
     • See FIREBASE_SETUP.md for detailed instructions
   • Build and run (⌘+R)

3. Voice Server Setup (Optional - for voice task creation)

   • Navigate to server/ directory
   • Install dependencies: npm install
   • Create .env file from env.example
   • Add your API keys:

     OPENAI_API_KEY=your_openai_key
     GOOGLE_AI_STUDIO_API_KEY=your_google_ai_key
     

   • Start server: npm run dev
   • See README_VOICE_SETUP.md for detailed setup

📁 Project Structure

ChorePal/
├── chorepal prototype/
│   ├── Views/           # UI components and screens
│   ├── Models/          # Data models and structures
│   ├── Services/        # Business logic and API services
│   ├── Voice/           # Voice task creation components
│   └── Resources/       # Assets and configuration
├── server/              # Node.js voice processing server
│   ├── src/
│   │   ├── routes/      # API endpoints
│   │   └── services/    # Voice processing logic
│   └── package.json
├── DATABASE_SCHEMA.md   # Firestore schema documentation
├── API_DOCUMENTATION.md # API reference
└── README_VOICE_SETUP.md # Voice feature setup guide

📚 Documentation

• DATABASE_SCHEMA.md - Complete Firestore database schema
• API_DOCUMENTATION.md - Service layer API documentation
• FIREBASE_SETUP.md - Firebase configuration guide
• README_VOICE_SETUP.md - Voice task creation setup
• VOICE_CUSTOMIZATION_GUIDE.md - Customize AI voice settings

👥 Team

• Rayyan Khan
• Amit Kalyankar
• Harshil Vanparia
• Ximena Armentero
• Cameron Westerburg

📄 License

This project is licensed under the MIT License.

🤝 Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📧 Contact

For inquiries, please open an issue on GitHub.