easystream_main_app

Prerequisites 📚

Yarn 1.0.0 or higher is required.

Installing dependencies with yarn.

yarn install

.env file in the root is required for development. Here is an example of a .env file:

BROWSER=none # Do not open a browser window when running the app

On Ubuntu >= 20.04, install the following libraries:

sudo apt-get install build-essential clang libdbus-1-dev libgtk-3-dev \
                       libnotify-dev libasound2-dev libcap-dev \
                       libcups2-dev libxtst-dev \
                       libxss1 libnss3-dev gcc-multilib g++-multilib curl \
                       gperf bison python3-dbusmock openjdk-8-jre

On Ubuntu < 20.04, install the following libraries:

sudo apt-get install build-essential clang libdbus-1-dev libgtk-3-dev \
                       libnotify-dev libgnome-keyring-dev \
                       libasound2-dev libcap-dev libcups2-dev libxtst-dev \
                       libxss1 libnss3-dev gcc-multilib g++-multilib curl \
                       gperf bison python-dbusmock openjdk-8-jre

Building and running the application 🚀

Command to build and run the application in final mode:

yarn start

IT IS OKAY IF IT BUG AT THE START, JUST TRY NEW TIMES WITH PC WORKING, AND IT'LL BE FINE ! Command to build and run the application only the front (with fake server results):

yarn run only-front

Command to run the application with the OBS plugin:

yarn run front-with-obs # Linux
yarn run front-with-obs-windows # Windows (You must setup env variable ELECTRON_IS_DEV=0)

Command to push release a new version:

npm version v<version>
git tag v<version>
git push --follow-tags

Then, you just have to run:

yarn run build-dist

It will create a draft release uploading all the important files.

Build Linux / Windows

Just run the following commands (do not forget to put the RELEASE env var to true)

yarn run build-dist

Linux instructions Windows instructions

Medium tutorial