README.md

9th Seed

A twitch bot designed to assist viewers of the St Louis Vintage Rotisserie Draft

Commands

Docker setup

Requirements

You will need docker desktop installed.

Starting

Populate a creds folder with a dbCreds.json and a twitchCreds.json.

Example dbCreds.json:

{
  "connectionLimit": 10,
  "database": "stlvrd",
  "host": "localhost",
  "password": "YOUR_PASSWORD_HERE",
  "user": "YOUR_USER_HERE"
}

Example twitchCreds.json:

{
  "username": "YOUR_USER_HERE",
  "password": "oauth:YOUR_OAUTH_HERE"
}

To run the environment hosted on docker, run the following:

docker-compose build
docker-compose up

Non-Docker setup

Requirements

You will need npm and mysql installed.

You will need a database called stlvrd created in mysql which is accessible to your user.

Populating the Database

To get data into the database (which assists or is required for many of the features of 9th Seed, run

npm run db

Starting

Populate a creds folder with a dbCreds.json and a twitchCreds.json.

Example dbCreds.json:

{
  "connectionLimit": 10,
  "database": "stlvrd",
  "host": "localhost",
  "password": "YOUR_PASSWORD_HERE",
  "user": "YOUR_USER_HERE"
}

Example twitchCreds.json:

{
  "username": "YOUR_USER_HERE",
  "password": "oauth:YOUR_OAUTH_HERE"
}

Run the following to start your bot watching the channel.

npm install
npm start

Code Quality

This project uses Mocha tests and ESLint to help ensure that it keeps working.