Skip to content

Latest commit

 

History

History
86 lines (57 loc) · 3.3 KB

README.md

File metadata and controls

86 lines (57 loc) · 3.3 KB
Raw

Local Party

GitHub stars GitHub forks GitHub license

Table of Contents

  1. Local Party
  2. Features
  3. Getting Started
  4. Video
  5. Media
  6. Contributing

Local Party

A website where you can create rooms and chat while watching local video files synchronized with your friends.


Features

  • Create watch party rooms.
  • Watch videos in sync with your friends.
  • Chat with your friends while watching videos.

Getting Started

  1. Go to https://localparty.netlify.app/

  2. To create a room, click on the create room button and enter the name you want to chat with, the room's name and select the video file.

  3. You would be redirected to the room page once you have created it. You can now share the room code with your friends and they can join with the same video file and room code.

  4. To join a room, click on the join room button and enter the name you want to chat with, the room's code and select the same video file with which the host has created the party with.

  5. You can view how many people are in the party by hovering over the user icon in the top right of the room page.

  6. You can leave the party by clicking on the leave icon in the top left of the chat section of the room page.

Video

Local Party Demo

Media

An album of screenshots of the website can be found here.

Contributing

  1. First, fork the repository to your GitHub account by clicking the "Fork" button on the top right of the repository page.

  2. Clone your forked repository to your local machine using the following commands:

    git clone https://github.com/your-username/local-party.git
cd local-party

  3. Next, set up the project by installing dependencies. Ensure you have Node.js and npm installed on your machine. If you haven't installed Node.js yet, you can download it from the official website.

    npm install

  4. Similarly, clone the repository of the API to your local machine using the git clone command. Navigate to the project directory.

    git clone https://github.com/your-username/local-party-api.git
cd local-party-api

  5. To view the project locally and make changes, you can open a live server.

    npm start

Backend API

If you're interested in contributing to the backend API, you can find its repository here.

We welcome contributions of all kinds, from bug fixes to new features. Please make sure to follow the Code of Conduct and Contributing Guidelines when contributing to this project.

Check out the backend API here.