Skip to content

shashanka2a/tribzy-hack

Repository files navigation

Tribzy - Roommate Matching Platform

Introduction

Tribzy is a revolutionary platform designed to streamline the process of finding compatible roommates for students and young professionals. Our platform leverages advanced AI algorithms to provide highly accurate roommate matches based on user profiles and preferences. This project was developed during the Austin AI Community Hackathon!

Features

  • User Profile Creation: Create detailed profiles with preferences, habits, and interests.
  • AI-Powered Matching: Utilize OpenAI's language model to determine compatibility between profiles.
  • Dynamic Matching: Receive real-time updates on potential matches.
  • Enhanced User Experience: Clean, intuitive interface with Tailwind CSS.

Technical Details

  • Backend: Django, SQLite
  • Frontend: Tailwind CSS, HTML
  • AI Integration: OpenAI's GPT-3.5-turbo

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/tribzy.git
    cd tribzy
  2. Create and activate a virtual environment:

    python3.9 -m venv myenv
    source myenv/bin/activate
  3. Install dependencies:

    pip install -r requirements.txt
  4. Run migrations:

    python manage.py makemigrations
    python manage.py migrate
  5. Create a superuser:

    python manage.py createsuperuser
  6. Run the server:

    python manage.py runserver

Usage

  1. Sign up: Navigate to the signup page and create an account.

  2. Create Profile: Fill in your profile details, including preferences, habits, and interests.

  3. Find Matches: Once your profile is created, use the matching feature to find compatible roommates.

Screenshots

1.Signup Page: SignUp Page 2. Login Page: Login Page 3. Create Profile Page: Create Profile Page 4. Profile Success Page: Profile Success Page 5. Response/Result: Result

User Flow Explanation

  1. Sign Up:

    • Users start by signing up on the platform, providing their username, email address, and password.
    • After signing up, they are redirected to the login page.
  2. Login:

    • Users log in with their credentials.
    • Upon successful login, users are redirected to the profile creation page.
  3. Profile Creation:

    • Users fill out their detailed profile, including preferences, habits, and interests.
    • The form includes fields such as guest frequency, sleep pattern, hobbies, smoking/drinking habits, pet-friendliness, gender, diet, personality, travel pattern, state in the US, major, degree type, career domain, and cooking skills.
    • Users can upload a profile picture and provide their name.
  4. Profile Success:

    • Upon submitting the profile form, users are redirected to a success page that confirms their profile has been created successfully.
    • Users can then proceed to find their roommate by clicking the "Find Your Roommate" button.
  5. Find Matches:

    • The AI algorithm processes the user profile and compares it with existing profiles in the database.
    • Matches are displayed with compatibility scores, allowing users to find the most compatible roommates.

Contributing

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature-branch).
  6. Open a pull request.

License

This project is licensed under the MIT License.

Contact

For more information, please contact [email protected]