https://github.com/im-calvin/mittens
A discord bot used to allow users to subscribe certain YouTube channels and receive notifications when they put up new schedules and go live.
https://github.com/im-calvin/mittens
discordjs docker node sql typeorm typescript
Last synced: 5 months ago
JSON representation
A discord bot used to allow users to subscribe certain YouTube channels and receive notifications when they put up new schedules and go live.
- Host: GitHub
- URL: https://github.com/im-calvin/mittens
- Owner: im-calvin
- Created: 2023-04-27T06:38:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-18T19:15:21.000Z (over 1 year ago)
- Last Synced: 2025-09-19T00:47:22.447Z (9 months ago)
- Topics: discordjs, docker, node, sql, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 1.06 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mittens
[](https://vault.dotenv.org/project/vlt_a88b4b86e3be377976336d5bc2d9f508d0792bbfd9cce02ce5af9879e452e3ca/example)
[](https://github.com/im-calvin/Mittens/actions/workflows/docker.yml)
[Add Mittens here!](https://top.gg/bot/631663182397702146)
If you have an issue or a feature request feel free to reach out to `calv.` on Discord.
This is version 2 of Mittens boasting a 200% speed increase over [version 1 of Mittens](https://github.com/im-calvin/mittens_bot_v1) through the use of a proper SQL database and a lot of code optimizations.
## What does Mittens do?
Mittens will monitor your chat for sentences and translates text from Japanese to English when required. In addition, Mittens keeps a schedule of (for now) Hololive streamers to notify you and your friends when someone on your following list goes live!
Mittens uses slash commands with autocomplete. Below is a list of commands supported:
- `add`: adds a streamer to your following list. You will get notifications in the channel you sent the command in
- `remove`: removes a streamer from your following list
- `list`: gets your current subscription list in your current discord channel
- `schedule [streamer], [group], [org]`: gets the scheduled streams (stream reservations) for a particular streamer, group, or organization. See [database](#database) for more info.
## Building & Running
You can either build it locally or use the Docker Hub Image
### Locally
1. Install required packages with `npm i`
2. Install `SQLite3` following [this documentation](https://www.sqlite.org/download.html)
3. Get a `.env` file by forking the repository and filling it out.
4. Run `npm start`
### Pull and Run with Docker
1. Pull: `docker pull imcalvin/mittens:latest`
2. Fill out the `.env` file on dotenv-vault and acquire a `DOTENV_KEY` for the next step
3. Run: `docker run -d -e DOTENV_KEY= imcalvin/mittens:latest`
### Building for Docker
First login: `docker login`
Build & Tag: `docker -t imcalvin/mittens:VER_NUM .`
Push: `docker push imcalvin/mittens:VER_NUM`
## Database
The database uses SQLite with TypeORM. Notes on the tables:
- The `languages` table refers to the organization (ex: Hololive) as well as the language (ex: English).
- The `groups` table is more specific and refers to a specific generation (ex: Hololive English Council)
## CI/CD
