Skip to content

Repository files navigation

🏠 Roomi AI Harmony

TypeScript React Vite Tailwind CSS License

🌟 A modern, AI-powered roommate management platform that streamlines household coordination, expense tracking, and communication.

📋 Meta Description

name: Roomi AI Harmony
description: Smart roommate management application for modern shared living
keywords: roommate management, expense tracking, chores management, shared living, household coordination
version: 1.0.0
author: Your Name
license: MIT
framework: React + TypeScript
UI: Tailwind CSS + Radix UI
backend: Supabase

Roomi AI Harmony is a modern roommate management application built with React and TypeScript, designed to make living with roommates easier and more organized.

✨ Features

  • 📊 Expense Tracking: Split bills and track shared expenses
  • Chores Management: Organize and track household tasks
  • 🔔 Smart Reminders: Never miss important payments or tasks
  • 💬 Group Chat: Built-in communication platform for roommates
  • 🎯 Feature Voting: Democratic decision-making for house rules and features
  • 🌐 Multi-language Support: Accessible in multiple languages
  • 💰 Currency Management: Handle expenses in different currencies
  • Premium Features: Access advanced features with subscription

🛠️ Tech Stack

  • Frontend: React + TypeScript
  • Build Tool: Vite
  • Styling: Tailwind CSS
  • UI Components: Radix UI
  • Authentication: Supabase
  • Animations: Framer Motion
  • State Management: React Context

🚀 Getting Started

Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn

Installation

# Clone the repository
git clone https://github.com/yourusername/roomi-ai-harmony.git

# Navigate to project directory
cd roomi-ai-harmony

# Install dependencies
npm install

# Start development server
npm run dev

🔧 Configuration

Create a .env file in the root directory with your Supabase credentials:

VITE_SUPABASE_URL=your_supabase_url
VITE_SUPABASE_ANON_KEY=your_supabase_anon_key

🔐 Google OAuth Setup

To enable Google OAuth authentication:

  1. Go to the Google Cloud Console
  2. Create a new project or select an existing one
  3. Navigate to "APIs & Services" > "Credentials"
  4. Click "Create Credentials" and select "OAuth client ID"
  5. Configure the OAuth consent screen:
    • Add your application name and logo
    • Add your support email
    • Add authorized domains (your domain and supabase.co)
  6. In the OAuth client ID creation:
    • Select "Web application" as the application type
    • Add authorized redirect URIs:
      • https://[YOUR_PROJECT_REF].supabase.co/auth/v1/callback
      • http://localhost:5173/auth/callback (for local development)
  7. Copy the Client ID and Client Secret
  8. In your Supabase project dashboard:
    • Go to Authentication > Providers
    • Enable Google OAuth
    • Add your Google Client ID and Client Secret
    • Add the authorized redirect URL: https://[YOUR_PROJECT_REF].supabase.co/auth/v1/callback

Note: Replace [YOUR_PROJECT_REF] with your actual Supabase project reference ID.

📱 Key Features Implementation

  • Page Transitions: Smooth 2-second transitions between pages with loading animations
  • Responsive Design: Works seamlessly on desktop and mobile devices
  • Theme Support: Light and dark mode with system preference detection
  • Real-time Updates: Instant updates for expenses and chores

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

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

🙏 Acknowledgments

Made by the Infinity Coders:- -Adwait Panigrahi -Sarwan Nandh -Anshuman Jaiswal -Anirudh Krishnan

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages