Skip to content

MrFByte/ZFaceMe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

6 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

ZFaceMe

ZFaceMe is a real-time video calling web application built with Django on the backend and HTML, CSS, and JavaScript on the frontend. It leverages WebSockets for establishing signaling connections and WebRTC for peer-to-peer video and audio communication.

πŸš€ Features

  • πŸ” User-friendly interface for initiating and receiving video calls
  • πŸ“‘ WebSocket-based signaling for real-time connection setup
  • πŸŽ₯ High-quality video and audio powered by WebRTC
  • πŸ’» Built with Django, offering a robust backend framework
  • πŸ–₯️ Responsive and clean frontend using HTML, CSS, and JavaScript

🧰 Tech Stack

Layer Technology
Backend Django
Frontend HTML, CSS, JavaScript
Real-time Comm WebSocket (signaling)
Media Stream WebRTC

πŸ“· How It Works

  1. Signaling Phase:

    • Users connect to a WebSocket server.
    • Signaling data (offer/answer) is exchanged.
  2. WebRTC Connection:

    • Peer-to-peer media connection is established.
    • Audio and video streams flow directly between clients.
  3. Video Call UI:

    • Clean and intuitive interface to start and end calls.
    • Dynamic video rendering using JavaScript DOM manipulation.

πŸ› οΈ Setup Instructions

Prerequisites

  • Python 3.8+
  • Virtualenv (recommended)

Installation

  1. Clone the repository

    git clone https://github.com/MrLionByte/ZFaceMe.git
    cd ZFaceMe
  2. Set up a virtual environment

    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
  3. Install dependencies

    pip install -r requirements.txt
  4. Run migrations and start the server

    python manage.py migrate
    python manage.py runserver
  5. Open in browser

    • Visit: http://127.0.0.1:8000 in your browser.

πŸ”§ Project Structure

ZFaceMe/
β”‚
β”œβ”€β”€ zfaceme/            # Django project files
β”œβ”€β”€ videoapp/           # Core app handling video logic
β”‚   β”œβ”€β”€ templates/
β”‚   β”œβ”€β”€ static/
β”‚   └── views.py
β”œβ”€β”€ manage.py
└── requirements.txt

πŸ“„ License

This project is open-source and available under the MIT License.


About

A Video-Chat app build for easy to use.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published