Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/katerberg/9th-seed
Twitch Bot and API for Vintage Rotisserie Draft
https://github.com/katerberg/9th-seed
Last synced: 8 days ago
JSON representation
Twitch Bot and API for Vintage Rotisserie Draft
- Host: GitHub
- URL: https://github.com/katerberg/9th-seed
- Owner: katerberg
- License: agpl-3.0
- Created: 2019-06-04T06:03:06.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T00:51:30.000Z (15 days ago)
- Last Synced: 2024-10-22T23:10:22.168Z (14 days ago)
- Language: JavaScript
- Homepage:
- Size: 59.7 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 9th Seed
A twitch bot designed to assist viewers of the [St Louis Vintage Rotisserie Draft](https://twitch.tv/stlvrd)
## 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](https://mochajs.org/) tests and [ESLint](eslint.org) to help ensure that it keeps working.