how-to-setup-showrunners.md

description
This page describes how to setup showrunners scaffold / framework which will enable you to rapidly create and deploy web3 notifications from backend.

How to Setup Showrunners?

Prerequisites

You should have the following installed on your system

• Docker
• Node JS
• NPM

Setting Up Showrunners

The initial step in setting up the showrunners is cloning the showrunners-HelloWorld repo

git clone https://github.com/ethereum-push-notification-service/push-showrunners-framework

This repository will contain the showrunner framework that you require to instantly build your channels logic.

Now in order to run this showrunner, we will need .env file which will contain your credentials that are required for fetching data from blockchains (for example, Infura).

For creating this .env file, simply copy the .env.sample file present in the root of the folder and replace the fields with valid credentials for each field.

# MAKE A COPY OF THIS AND FILL WITH YOUR CREDENTIALS AND NAME IT .env (Remove .sample Part)

# SHOWRUNNERS ENVIRONMENT: prod or staging or dev
SHOWRUNNERS_ENV=staging

## NORMAL CONFIG
# DEBUG | CAN BE 'debug' or 'prod'
LOG_LEVEL=debug_or_prod # 'debug' or 'prod'

# WEB3 ENDPOINTS | NEED ATLEAST INFURA OR ETHERSCAN OR ALCHEMY, REST CAN BE NULL
INFURA_PROJECT_ID=your_infura_project_id
INFURA_PROJECT_SECRET=your_infura_project_secret

## ADVANCED CONFIG
# WEB3 ENDPOINTS | OPTIONAL IF YOU FILLED INFURA_PROJECT AND INFURA_PROJECT_SECRET, CAN SET IT TO NULL IF YOU WANT TO
ETHERSCAN_API=your_etherscan_api_key_or_null
ALCHEMY_API=your_alchemy_api_key_or_null

Param	Valid Values	Comment
SHOWRUNNERS_ENV	prod or staging	Describes the Push Network you are targeting. If you deployed your channel on staging then this will be staging else if you deployed on mainnet (even multi-chain channel) then this will be prod.
LOG_LEVEL	debug or prod	Changes the amount of log generated, recommended to use debug until you are sure of the logic.
INFURA_PROJECT	your_infura_project_id or null	Head to infura.io to generate one, required to query data of blockchain. Need atleast one (Infura, Etherscan or Alchemy) to operate correctly.
INFURA_PROJECT_SECRET	your_infura_project_secret or null	Head to infura.io to generate one, required to query data of blockchain. Need atleast one (Infura, Etherscan or Alchemy) to operate correctly.
ETHERSCAN_API	your_etherscan_api_key or null	Head to etherscan.io to generate one, required to query data of blockchain. Need atleast one (Infura, Etherscan or Alchemy) to operate correctly.0
ALCHEMY_API	your_alchemy_api_key or null	Head to alchemy.com to generate one, required to query data of blockchain. Need atleast one (Infura, Etherscan or Alchemy) to operate correctly.

{% hint style="danger" %} At least INFURA_PROJECT, INFURA_PROJECT_SECRET or ETHERSCAN_API or ALCHEMY_API key is required to correctly operate showrunners. Recommended to put all as the data fetching becomes more decentralised. {% endhint %}

Running the Showrunners

Now that you have set up the showrunners .env file, you are all set to run the showrunners. To do that first ensure:

Install dependancies

• All dependencies are installed, open the terminal (or command prompt), and go to the root of the cloned repo, npm install or yarn install to install dependencies.

{% tabs %} {% tab title="npm" %}

npm install

{% endtab %}

{% tab title="yarn" %}

yarn install

{% endtab %} {% endtabs %}

Run Docker Image

• Next, type docker-compose up to start running docker image

docker-compose up

Start the server

• Finally, open another terminal and ensure you are still at the root of the cloned repo and fire npm start or yarn start

{% tabs %} {% tab title="npm" %}

npm start

{% endtab %}

{% tab title="yarn" %}

yarn start

{% endtab %} {% endtabs %}

If everything is good, this is the output that you should see! Congrats, you just installed Showrunners framework ☺️☺️ running on the port:5432 🦾

{% hint style="info" %} You might see that showrunners are throwing an error explaining that no channels can be found, a channel is what is needed to run logic controls through showrunners.

Let's dive in and see how to create your hello world channel to run on top of the showrunners framework! {% endhint %}