meta.dev‐setup

This file lists all things that are needed to get the Bot up and running for development.

Port Ranges

All Applications in this project run on the ports 4770+ (4770, 4771, ...)

Docker

The primary target will be docker, so we will need to test the bot in docker from time to time. It sometimes is a bit cumbersome to install docker, but I would advise you to do so, because it will make it significantly easier to update the DB version and configure additional needed services if they are needed in the future. To install docker, follow the official installation guide for your OS:

Warning

Make sure virtualization is enabled in the bios And make sure to read the official documentation closely

DB

You can use an external MySql compatible database, but the easiest way would be to use the docker-compose in the project root. If you decide to use something different you will have to change the spring.datasource.driver-class-name and spring.jpa.database-platform in application.properties and the normal connection parameters.

Bot Backend

Entrypoint: talium.TwitchBot
Java: Java 21 SDK
Build Tool: Maven
Webserver Port: 4771 || server.port in application.properties
Spring Config: application.properties

Copy application-example.properties as application-local.properties (or any other profile name of your choosing). Then use this as a starting point and fill in all the variables.

Then run the bot backend with the correct spring profile selected.

Panel

npm install
create .env.local with the client id of the login twitch app inVITE_TWITCH_CLIENT_ID
create .env.production with the client id, and overwrite any urls, if needed for your environment
npm run for dev
npm build && npm preview for prod/release version