https://github.com/danarmor/vtuber-go
Telegram bot that reminds users about streams of selected vtubers
https://github.com/danarmor/vtuber-go
entgo golang holodex hololive react self-hosted telegram telegram-bot telegram-mini-app typescript vtuber
Last synced: 28 days ago
JSON representation
Telegram bot that reminds users about streams of selected vtubers
- Host: GitHub
- URL: https://github.com/danarmor/vtuber-go
- Owner: DanArmor
- Created: 2023-12-20T16:51:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-18T15:38:29.000Z (11 months ago)
- Last Synced: 2025-07-18T19:11:10.203Z (11 months ago)
- Topics: entgo, golang, holodex, hololive, react, self-hosted, telegram, telegram-bot, telegram-mini-app, typescript, vtuber
- Language: TypeScript
- Homepage:
- Size: 2.72 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vtuber-go
- [About](#about)
- [Running instance](#running-instance)
- [How to selfhost](#how-to-selfhost)
- [Deploy](#deploy)
- [Configuration](#configuration)
- [How to populate data](#how-to-populate-data)
## About
Telegram bot that reminds users about streams of selected vtubers.
It has user interface implemented via Telegram Mini App mechanism. You can access it by pressing 'Menu' button in the lower left corner.
Select the streamers whose broadcasts you want to be notified about. You can use filters by:
- *name*;
- *company*;
- *wave*;
- *all/selected/not selected property*.
Also in "Show" tab you can hide tags of vtubers and avatars.
In "Settings" tab you can select the shift from GMT of your local time to get proper "start time" value. If you didn't select any - it will format start time as GMT +0.
Also you can click on streamer in list and got streamer card with links to their accounts on youtube/twitch/twitter and etc.
To get help message send `/start` command to the bot.
Can be used as learning example of Telegram Mini App
Based on example from [vkruglikov/react-telegram-web-app](https://github.com/vkruglikov/react-telegram-web-app)
Built with Golang + Ent + Gin / Typescript + React + Ant Design.
## Running instance
[Link to running instance](https://t.me/vtuber_go_bot).
Sends a notification 30 minutes before the stream.
## How to selfhost
### Deploy
You need 3 things:
- [Holodex API key](https://holodex.net/);
- [Telegram Bot (its token)](https://t.me/botfather);
- Server to run on with the access to external users to connect to it (to access web interface. Also you want some domain to got certificate to run web interface over https).
When you setuped your server, you need to clone the repo to it, enter `.docker` dir, change .env and config.yaml according to your needs and run:
```bash
docker compose up -d
```
Done - it will build all the images and run the application.
### Configuration
Clarification of some config.yaml values:
```bash
base_path - the path after hostname and port to bind backend to.
expiration_hours - expiration time in hours for jwt token
admin_token - token for administration endpoints
time_notify_after - time threshold in minutes after which the notification should be sent
time_step - time step in minutes for check streams time. If you set it to 2 - it will check time of streams every 2 minutes.
```
Also don't forget to change backend url in `frontend/src/config.ts` accordingly to your setup and setup database params in .env *and* config.yaml.
Furthermore, you need to create empty `secrets.ts` file in `frontend/src` directory.
### How to populate data
You can use Holodex API to get data about vtubers. Example:
```shell
curl --request GET \
--header "X-APIKEY: " "https://holodex.net/api/v2/channels?org=Hololive&limit=50" > out.txt
```
And use data from out.txt to send it into Vtuber-Go (`/api/admin/vtubers`) with curl or [Postman](https://www.postman.com/) in format:
header: `ADMIN-TOKEN: `
body:
```json
{
"vtubers":
}
```
At the moment you can use only vtubers, that are available with Holodex, cause we use Holodex API to check available streams.