lol-cup-pick-ban-ui/README.md

ZSŁ LOL CUP - Pick and ban UI

This is a fork of a popular overlay package that displays graphics during pick phase in League of Legends. It has graphics and color palette that matches the 6. edition of ZSŁ LOL CUP tournament. It also includes updated dependencies so it's easier to install and requires no additional configuration.

Installation

• Requirements
  • Node.js >=19.0.0

1. Clone the repository

$ git clone https://github.com/zsl-gdansk/lol-cup-pick-ban-ui.git
$ cd "lol-cup-pick-ban-ui"

2. Install dependencies using yarn

$ yarn install

3. Build applications

$ yarn build

4. Start both projects using

$ yarn start

Apps

• backend - running WebSocket server on port 8999
• frontend - http://localhost:3000

Configuration

The following environment variables are supported:

• backend
  • PORT - overwrite backend WebSocket port (optional, default: 8999)
  • LOGLEVEL - overwrite logger settings (optional, default: "info")
  • NO_API - if exported, backend will read teams data from config.json file (optional)
  • DATA_ENDPOINT - HTTPS endpoint address to fetch teams data (optional, default: "https://lolcup.zsl.gda.pl/api/overlays/schedule/current")

Read more

Documentation of the original project