@tycoonsystems/tycoon-modules NPM

Start developing your Video Platform

npm init @tycoonsystems/tycoon-modules

Enterprise TV Platform

This is a library for an enterprise TV platform. You can spin up a platform similar to Netflix, YouTube or Mubi using these modules. Just a few functionalities that are included are:

Controllers for using our RTMP livestreaming services
User onboarding
Query param handling for pages like profile, watch, product, etc
Live chat
Forums
Recommendation search
Comments
Paywalling, e-commerce and cart
Upload pipelines

To start email us at: admin@tycoon.systems

Documentation

www.tycoon.systems/documentation

Notes

Use Bash terminal

Setup

If you see a bunch of errors in VS Code while developing try: 1. Ctrl+Shift+P -or- ⌘+shift+P 2. Then type: Developer: Reload Window

video-streaming-client

Video Streaming Client leveraged for Official Tycoon Network and B2B Customers

Start in order of command below. Must use Bash for following commands

export NVM_DIR="$( -z "${XDG_CONFIG_HOME-}" && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")" -s "$NVM_DIR/nvm.sh" && . "$NVM_DIR/nvm.sh" # This loads nvm

Use Node.js 16

nvm use 16

Check node versions

nvm ls

Git Operations

You must fork this and create your own repo

Go to https://github.com/Tycoon-Systems-Corp/video-streaming-client and click Fork

Add Upstream repo once you have forked into your own repo

git remote add upstream https://github.com/Tycoon-Systems-Corp/video-streaming-client

Create app.config.js file in root. See example file here: https://tycoon-public-share.s3.us-east-2.amazonaws.com/app.config.js

vi app.config.js

To safely pull /modules folder changes run update script

./update

If update script is missing run

git checkout -p upstream/master -- update.sh

Or manually copy temporarily to root / using modules/defaults/scripts/update and then run

./update

If you get Permission denied run following

chmod 722 update_version

Push data up to your repo

git push

Run init_app.js to create required dependency files. Else errors will throw in development

node init_app.js

Install npm packages

npm install

For more information go to https://tycoon.systems/documentation?q=initialize%20application

Start developing

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3020 with your browser to see the result.

Run application locally on https

npm run https

Packages

If you are missing dependencies check /modules/dependencies.txt Ensure all of these exist atleast once in package.json file

You can make sure all required packages are installed on DEV or PROD by navigating to /admin in app and then going to build. Then you will want to click "Build" tab and upload a package.json. Then click "run npm install"

To Analyze Dependency Sizes use the following

ANALYZE=true npm run build

How to Develop

See the documentation.md folder for application tooling and functions See api.md for routes to public Platform API

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.js.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Deployment

Favicons

Generate Favicons here https://favicon.io/favicon-converter/ Place in public folder In customModules\middleware\Middleware.js add following code:

import Head from 'next/head' ... return ( ...

<Head>
    <link rel="shortcut icon" href="/favicon.ico" />
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
    <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/>
    <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/>
</Head>