YDO (You Deserve One) 💖

A unique matchmaking application.

✨ Project Overview

YDO (You Deserve One) is a unique matchmaking application. Users select 5 choices, and if two users mutually select the same individual, they are revealed as a match.

What We're Building

YDO focuses on:

• Easy-to-Use Design: A beautiful and intuitive interface.
• Top-Notch Privacy: Keeping your data safe with encryption. Anonymous even to the developers.
• Fast Performance: Load and search through everyone, in seconds.
• Great Profiles: A fun and informative way to showcase yourself.

---

🛠 Tech Stack

• Backend: Python, Supabase, Flask
• Frontend: React, Lucide (icons), JavaScript (no TypeScript)

---

🚀 How to Contribute

We welcome all contributions, including bug reports, feature requests, documentation improvements, and code contributions.

Before you dive into the code, make sure to check out the CONTRIBUTING.md.

It’s got all the detailed instructions you need to get started – including commit message formats and more!

---

🗺️ Roadmap Highlights

Our development roadmap is structured around key features:

• Frontend: Home page, Login form, Dashboard, Toast notifications, Opt-out page, Dynamic search/select, Dynamic profile view.
• Backend: Login logic (restrict to @iiitdmj.ac.in), Search endpoint, Dynamic opt-out, Profile management, Public key exchange, Choice selection, Fake requests/selects.
• Research: Data extraction from iiitdmj.ac.in.

Expect many smaller, in-between issues as we progress.

---

📂 Project Structure

• backend/ - Python Flask API and Supabase interactions
• frontend/ - React frontend application
• supabase/ - Supabase local config

---

📦 Setting up locally

1. Fork this repo 🍴

2. Clone it 🔽

   git clone [your-fork-url] YDO

3. Install Docker. Make sure it is running using the command:

   docker --version

4. Install Node.js (v22 or later) and Python (v3.11 or later).

5. Install Supabase CLI.

6. In supabase/.env input required environment variables, Ask on discord if you need help.

7. Start the run.py script and you are good to go!

   python run.py

   Or

   python3 run.py

8. Press Ctrl + C to stop the script when you are done.

Note: It is highly recommended to review the script and try to understand what commands it runs.

---

🎨 Design Resources

• Figma Link

---

Made with 💖 by Team YDO.