Open-Twitch is a clone of Twitch, a live streaming platform, built using Express.js with TypeScript. It incorporates various technologies such as Nginx, Docker, Jest for testing, Socket.io for real-time chat, and RTMP for streaming.
- Clone the repository:
git clone https://github.com/Open-Twitch/Twitch-Server.git
Without docker
- Provide environment variables based on the .env.example file.
- Install dependencies:
npm install- Run the development server:
npm run dev- Clone the RTMP microservice repository:
git clone https://github.com/Open-Twitch/rtmp-server- Navigate to the RTMP microservice directory and follow the same steps as above to set up and run the microservice.
With docker
- Provide environment variables based on the .env.example file.
- Make sure Docker is installed and running on your system.
- Run the following command to start both the server and RTMP microservice using Docker Compose:
docker-compose up app- For detailed documentation on the APIs and how they work, please refer to the api-documentation file.
- Contributions are welcomed! Feel free to submit pull requests, report issues, or suggest new features. This project is open-source under the MIT License.