Skip to content

Muzical is a platform that let's you enjoy watching youtube videos and songs in-sync with friends and family members. All you need to do is just join a channel and start enjoying ✨

License

Notifications You must be signed in to change notification settings

anand346/muzical

Repository files navigation

Muzical banner

Muzical Welcomes You ✨👋

Muzical is a groundbreaking web application that brings people closer together through the power of synchronized video streaming.

Whether you're separated by miles or just sitting in the same room, Muzical allows you to watch YouTube videos simultaneously with your friends and family members, creating a shared entertainment experience like never before.

Key Features 🎯

  1. Synchronized Viewing: Watch YouTube videos in perfect harmony with your loved ones, no matter where they are in the world.

  2. Invite Friends: Easily invite friends and family to join your viewing party with a simple link or code.

  3. Customizable Experience: Tailor the viewing experience with playback controls and quality settings.

  4. Cross-Platform: Access SyncTube from your web browser on desktop or mobile devices, ensuring everyone can participate.

Live Demo 😀

Visit our live demo to experience Muzical in action. Invite your friends and start watching videos together right now!

Tech Stack ⚙️

Javascript Nex.js

Tailwindcss

Make Your Contribution 🚀

We believe in the power of collaboration, and your contributions can help make Muzical even more amazing. Whether you`re a developer, designer, tester, or just enthusiastic about improving Muzical, there are several ways you can contribute:

1. Code Contributions

  • Bug Fixes: Help us squash bugs by submitting detailed bug reports or fixing them yourself and opening a pull request.

  • Feature Development: If you have ideas for new features or improvements, let us know or dive right in and start coding.

  • Enhancements: Help us optimize and enhance existing features to make Muzical smoother and more user-friendly.

2. Documentation

  • Improvements: Contribute to our documentation by suggesting edits, adding missing information, or writing new guides.

3. Testing

  • Quality Assurance: Help us ensure Muzical is robust and reliable by testing new features and reporting any issues you find.

4. Spread the Word

  • Tell Others: If you enjoy using Muzical, spread the word to your friends and on social media. The more, the merrier!

Getting Started

To start contributing, follow these steps:

  1. Fork the Muzical repository to your GitHub account.

  2. Clone the forked repository to your local machine. git clone https://github.com/<your_github_username>/muzical

  3. Get into the root directory cd muzical

  4. Install all dependencies by running npm install

  5. Make .env.local file and put these variables:

ABLY_API_KEY=<Your Ably API key>
NEXT_PUBLIC_API_ROOT="http://localhost:3000"

To get your Ably API key, create your account here and go through this guide .

  1. Run the project in your local machine npm run dev

  2. Create a new branch for your contribution: git checkout -b <your-branch-name>

  3. Make your changes, whether it`s code, documentation, or testing.

  4. Stage your changes git add <file_name>

  5. Commit your changes: git commit -m "Add your meaningful commit message here"

  6. Push your changes to your fork on GitHub: git push origin <your-branch-name>

  7. Open a pull request from your branch to the main Muzical repository.

  8. Our team will review your contribution, provide feedback, and merge it once it meets our standards.

Let's make Muzical even better together! Your contributions are greatly appreciated. 🚀🙌

Contact Us 📭

Got questions or feedback? Reach out to us through mail. We`d love to hear from you!

Join the Muzical community today and bring your loved ones closer through the magic of synchronized video viewing. 🎥✨👫

About

Muzical is a platform that let's you enjoy watching youtube videos and songs in-sync with friends and family members. All you need to do is just join a channel and start enjoying ✨

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks