Giter VIP home page Giter VIP logo

neeraj319 / streammmm Goto Github PK

View Code? Open in Web Editor NEW
31.0 1.0 4.0 770 KB

A twitch like platform.

Home Page: https://streammmm.readthedocs.io/

License: MIT License

JavaScript 1.19% Dockerfile 0.87% Shell 0.14% TypeScript 96.11% Makefile 0.49% Python 0.67% HTML 0.47% CSS 0.07%
backend nginx rest rtmp typescript nodejs postgres prisma nestjs docker hls-live-streaming microservice hacktoberfest react

streammmm's Introduction

Streammmm

A real-time live streaming web backend written in NestJS.

Documentation : https://streammmm.readthedocs.io/

Run Locally

git clone https://github.com/Neeraj319/streammmm
cd streammmm
  • Create .env file and add environment variables according to .env.example

Using Docker

make build
  • for nth run
make up

Normal Installation (This won't work if you are using windows use docker installation instead or use WSL)

npm install yarn
yarn install
  • copy the nginx.conf file present in rtmp/ folder and add it to /etc/nginx/
  • Reload nginx with
sudo nginx -s reload
  • Database setup Add your own config and make sure to edit .env file
yarn start:dev

Architecture

alt text

Using the API

Streaming using the API

  • Create a user and it's channel by following the api docs. Now create a video grab your stream key from api (Look at the API docs for all API endpoints)
  • Install OBS from -> https://obsproject.com/download
  • Open OBS follow the default instructions for setup
  • Follow the images below for instructions

alt text

  • Select Screen Capture (XSHM) and OK

alt text

Stream Key setup

  • In the up-left coroner you will find files options. You will also find Settings option there. Select stream option and follow the instructions in the image

alt text

  • Set Server Url to: rtmp://localhost:1935/streaming

  • In streamkey inputbox make sure to get the right stream key of your channel otherwise it won't work.

  • Now start the stream by:

alt text

To view the stream you can use VLC media player or HLS demo app

I'll be showing with HLS demo app

  • go to https://hls-js.netlify.app/demo/

  • hls stream url: http://localhost:8080/hls/generate_stream_file_name.m3u8

  • Change the last url parameter to your stream/videos's file name provided by the api

alt text

You should be able to view the stream on the player now.

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code_of_conduct.md.

streammmm's People

Contributors

dibashthapa avatar neeraj319 avatar nischal0x01 avatar thenishantsapkota avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

streammmm's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.