Skip to content

pracheersrivastava/MatchU

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

MatchU

MatchU Logo

License: MIT Build Status React Native Node.js Python

A secure dating app for VIT Bhopal students, featuring AI-powered verification and machine learning compatibility matching.

Features

  • Secure Verification: OTP via VIT email and AI-based ID/face matching using DeepFace and Tesseract (~75% accuracy)
  • Smart Matching: ML compatibility model trained on OkCupid dataset (~60k profiles)
  • Privacy-Focused: Hosted on Oracle Cloud with Firebase authentication, Firestore database, MinIO storage, and Cloudflare CDN
  • VIT-Compatible: Fully functional on HTTPS-only network (Fortinet restrictions)
  • Cross-Platform: React Native app for iOS and Android

Tech Stack

Component Technology
Frontend React Native (Expo)
Backend Node.js (Express)
ML Backend FastAPI (Python)
Auth & DB Firebase (Auth, Firestore)
Storage MinIO
Infrastructure Oracle Cloud, Cloudflare
Version Control GitHub
Backups Google One (via rclone)

Project Structure

MatchU/
├── frontend/         # React Native mobile app
├── backend/          # Node.js/Express API server
├── ml/               # FastAPI ML models
├── docs/             # API documentation
├── scripts/          # Deployment and backup scripts
├── assets/           # App assets and logos
└── .github/          # CI/CD workflows

Getting Started

Prerequisites

  • Node.js 18 or higher
  • Python 3.9 or higher
  • npm or yarn
  • Git

Installation

  1. Clone the repository

    git clone https://github.com/pracheersrivastava/MatchU.git
    cd MatchU
  2. Frontend Setup

    cd frontend
    npm install
    npx expo start
  3. Backend Setup

    cd backend
    npm install
    npm start
  4. ML Backend Setup

    cd ml
    pip install -r requirements.txt
    uvicorn app:app --reload

Environment Configuration

Create .env files in frontend/, backend/, and ml/ directories based on the provided .env.example templates.

Required credentials:

  • Firebase project configuration
  • Oracle Cloud credentials
  • MinIO access keys
  • Cloudflare API tokens

Note: The OkCupid dataset (~924MB) is stored externally. Run scripts/fetch-dataset.sh to download it.

Contributing

We welcome contributions from the community.

Development Workflow

  • Use the develop branch for active development
  • Create feature branches from develop for new work
  • Submit pull requests to develop with at least one review

Reporting Issues

Please report bugs and feature requests through GitHub Issues.

CI/CD

  • Automated testing runs on push and pull requests
  • Deployment to Oracle Cloud via GitHub Actions

Screenshots

Coming soon.

License

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

Acknowledgments

Built by a team of 5 students. Infrastructure provided by Oracle Cloud, Firebase, MinIO, and Cloudflare.

About

College dating app for VIT Bhopal (React Native, Node.js, FastAPI).

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors