Skip to content

README.md

Latest commit

 

History

History
126 lines (89 loc) · 2.95 KB

README.md

File metadata and controls

126 lines (89 loc) · 2.95 KB

CHATRIFY

Connect Instantly, Communicate Seamlessly, Experience Limitless Interaction

Last Commit Repo Size Top Language License

🛠️ Tech Stack

Backend & Realtime

  • Node.js
  • Express
  • Socket.IO
  • WebRTC
  • Redis

Microservices & Tools

  • Python
  • FastAPI
  • Go
  • Axios

📑 Table of Contents

📌 Overview

Chatrify is a comprehensive developer toolkit designed to facilitate the creation of real-time communication, matchmaking, and personalized experiences. It seamlessly integrates WebRTC for peer-to-peer video and audio, robust backend services for scalable chat and user management, and intelligent matchmaking with vector similarity search and Redis queues.

This project simplifies the development of interactive, real-time applications. The core features include:

  • 🎯 Matchmaking & Recommendations: Efficiently pair users with personalized suggestions using Redis queues and vector similarity.
  • 🔗 WebRTC Signaling: Manage real-time media streams with WebRTC and Socket.IO for smooth peer-to-peer communication.
  • ⚙️ Scalable Backend: Built with Express, Redis, and modular models to support secure, high-performance chat and user sessions.
  • 💬 Frontend Integration: User-friendly interfaces for registration, login, and media interaction.
  • 🔐 Secure & Modular: Designed for easy extension, ensuring secure, reliable, and maintainable real-time apps.

✨ Features

  • 🎯 Smart Matchmaking
  • 🔗 WebRTC Signaling
  • 💬 Real-Time Chat
  • 🚀 Scalable Backend
  • 🔒 Secure & Extensible

🚀 Getting Started

📦 Prerequisites

  • Node.js (v18+)
  • npm
  • Python (3.9+)
  • Go
  • Redis

🧰 Installation

git clone https://github.com/Adeelser/Chatrify.git
cd Chatrify
npm install
pip install -r Backend/RecommenderService/requirements.txt
cd Backend/MatchMakingService && go build

▶️ Usage

npm start
python Backend/RecommenderService/src/main.py
go run Backend/MatchMakingService/cmd/matchMaking/main.go

Ensure Redis is running.

🗂️ Project Structure

Chatrify/
├── Backend/
├── Frontend/
├── .env.example
├── package.json
└── README.md

🛣️ Future Roadmap

  • Authentication (JWT/OAuth)
  • AI-powered matchmaking
  • Docker & Kubernetes

📄 License

MIT License