Thank you for your interest in contributing to StreamSync! Here’s how you can get started:

🛠 Local Setup

1. Fork the repository from GitHub.

2. Clone your forked repo:

   git clone <https://github.com/your-username/streamsync.git>
   cd streamsync
   

3. Install dependencies using pnpm:

   pnpm install
   

4. Start the development server:

   pnpm run dev
   

Docker setup is not introduced yet.

Docker Compose support will be added soon.

🌳 Branch Naming Convention

• For new features:

  feat/<name-of-the-feature>

• For bug fixes:

  bug/<name-of-the-bug>

Example:

feat/chat-system or bug/login-error

✅ Contribution Workflow

1. Complete the local setup steps.

2. Create a new branch using the naming convention mentioned above.

3. Sync your new branch with the latest main branch:

   git checkout main
   git pull origin main
   git checkout feat/<your-feature>
   git merge main