Skip to content

team-kwitch/kwitch

Repository files navigation

Kwitch

A service for streaming on the modern web browser only.

Try it online at https://kwitch.online

vercel com_sukjuhongs-projects_kwitch-web

Showcase

  • Stream manager screen image

  • Viewer screen image

Prerequisites

Tip

This project leverages Dev Containers to provide a consistent and automated development environment. By using Dev Containers, you can save time on setting up dependencies and ensure that all contributors are working within the same environment.

  • Docker
  • Visual Studio Code (VS Code)
    • Dev Containers Extension

Running the Project with Dev Containers

  1. Install Visual Studio Code (VS Code) and the Dev Containers Extension.

  2. Clone the repository:

git clone https://github.com/team-kwitch/kwitch.git
cd kwitch
  1. Open the project folder in VS Code.

  2. Open the VS Code command palette (Ctrl+Shift+P) and select Dev Containers: Reopen in Container.

  3. The Dev Container will be set up, and all necessary dependencies will be installed automatically.

  4. Open a terminal within the Dev Container and run the project:

pnpm dev

Warning

If you are not using Dev Containers, you need to set up the environment with pnpm, PostgreSQL, and Redis. Additionally, you must follow the Prerequisites listed in the mediasoup installation documentation.

Related posts (in korean)

https://velog.io/@sukjuhong/series/Kwitch

Licence

This project is licensed under the MIT License. See the LICENSE file for more details.