Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/neeraj319/streammmm

A twitch like platform.
https://github.com/neeraj319/streammmm

backend docker hacktoberfest hls-live-streaming microservice nestjs nginx nodejs postgres prisma react rest rtmp typescript

Last synced: about 1 month ago
JSON representation

A twitch like platform.

Host: GitHub
URL: https://github.com/neeraj319/streammmm
Owner: Neeraj319
License: mit
Created: 2022-08-12T12:17:50.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2023-10-27T05:41:33.000Z (about 1 year ago)
Last Synced: 2024-12-03T17:08:38.012Z (about 2 months ago)
Topics: backend, docker, hacktoberfest, hls-live-streaming, microservice, nestjs, nginx, nodejs, postgres, prisma, react, rest, rtmp, typescript
Language: TypeScript
Homepage: https://streammmm.readthedocs.io/
Size: 752 KB
Stars: 31
Watchers: 1
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: code_of_conduct.md

Awesome Lists containing this project

README

# 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)

- Install nodejs from https://nodejs.org/en/
- Install PostgreSQL from https://www.postgresql.org/download/
- Follow this manual to install niginx-rtmp module https://github.com/arut/nginx-rtmp-module/
- Install FFMPEG from https://ffmpeg.org/download.html

```
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](images/streammm_system_architecture.svg)

## Using the API

- go to http://localhost:nest_js_port:/docs to view the documentation of 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](/images/img_1.png)

- Select Screen Capture (XSHM) and OK

![alt text](/images/img_2.png)

### 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](/images/img_3.png)

- 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](/images/img_4.png)

### 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](/images/img_5.png)

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](https://github.com/Neeraj319/streammmm/blob/master/code_of_conduct.md).