Zefevr / StreamZF

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

javaScript icon react icon redux icon html icon css icon

StreamZF App

This repo contains a bolierplate for an streaming app. It uses React/Redux in the frontend, the backend exposes a REST API done by a json-server and the OBS is connected using Rtmp-server.


Installation:

Clone this repository:

  • On Server's folder: Run npm ito install dependencies and npm start.

  • On Rtmpserver's folder: Run npm ito install dependencies and npm start.

  • On Client's folder: Run npm i to install dependencies and npm start to listen to local port.


List of features:

  1. OAuth:

    Ability to login using google authentication.

  2. CRUD:

    Logged in users can edit / create / delete their streams. Not logged users can only see (Get) the list of streams and watch them

  3. Streaming:

    Using an OBS program to stream and connected to the application by rtmpserver.


Pre-requesists:

  1. Get OAuth Client-Id:

    here it explains how to get a client-id for google OAuth.

    After cloning the repository, you can replace this client-id and put it in client/src/components/GoogleAuth.js

  2. Install OBS:

    You will need to have an OBS streaming program, you can get it here.

    In settings / stream:

    • Set URL : rtmp://localhost/live
    • Set Key : "ID of the stream you created in you the app". If you do not know which ID has your stream, you can see it in server/db.json. Remember that the stream must have been created by you.

About


Languages

Language:JavaScript 94.9%Language:HTML 4.6%Language:CSS 0.5%