Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/partyhatgg/yapper
A Discord bot for transcribing voice messages/media on Discord
https://github.com/partyhatgg/yapper
Last synced: about 8 hours ago
JSON representation
A Discord bot for transcribing voice messages/media on Discord
- Host: GitHub
- URL: https://github.com/partyhatgg/yapper
- Owner: partyhatgg
- Created: 2023-12-23T08:58:46.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-31T08:20:47.000Z (9 days ago)
- Last Synced: 2024-10-31T09:24:28.681Z (9 days ago)
- Language: TypeScript
- Homepage:
- Size: 765 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- starred - partyhatgg/yapper - A Discord bot for transcribing voice messages/media on Discord (TypeScript)
README
# Yapper
Welcome to the repository for Yapper, a Discord bot created to transcribe Discord voice messages.
## Self Hosting
### Running with Docker:
Please duplicate `.env.example` to `.env.prod` and `.env.dev`, then modify all the values accordingly and do the same for `./prisma/.env`.
The default fields here are already configured for running in Docker.
Then: `docker compose up` :)
### Running Locally:
To run this bot you will need Node.js `v18.20.2` or higher. Then, using a system installed `pnpm` (or, `pnpm` provided by corepack with `corepack prepare`) run `pnpm install` to install the bot's dependencies.
Then, please duplicate `.env.example` to `.env.prod` and `.env.dev`, then modify all the values accordingly and do the same for `./prisma/.env`.
This bot uses PostgreSQL! The format for a `DATABASE_URL` is:
```
postgresql://[user[:password]@][host][:port][/dbname]
```
Using RunPod
You will be asked for an `RUNPOD_API_KEY`, `RUNPOD_LQ_ENDPOINT_ID`, and `RUNPOD_HQ_ENDPOINT_ID`.
From the [RunPod Console](https://runpod.io/console), select ["Serverless"](https://www.runpod.io/console/serverless), then ["Quick Deploy"](https://www.runpod.io/console/serverless/quick-deploy) and select "Faster Whisper". RunPod will recommend a 24 GB GPU, this is perfectly fine. However, feel free to switch to the "16 GB GPU".
For many developers, you may set your `RUNPOD_LQ_ENDPOINT_ID` *and* `RUNPOD_HQ_ENDPOINT_ID` to the value under the name "Faster Whisper", or whatever custom name you've provided:
Next, select ["Settings"](https://runpod.io/console/serverless/user/settings), expand "API Keys" and create a new API Key with "Read" permission. Write permissions will allow this API key to modify your account, which is probably not what you want. This key is your `RUNPOD_API_KEY`.
## Running without Docker:
* Ready the Database with `pnpm prisma migrate dev`.
Then, to run the bot in production mode use `pnpm start`.
Or, to run the bot in development mode use `pnpm build`.
> [!TIP]
> Using development mode will provide you with more detailed logs and push guild commands in the specified `DEVELOPMENT_GUILD_ID` instead of global commands.
If you run into any problems with either [please create an issue](/issues/new).
### Need a Tunnel to Develop Locally?
Follow the instructions here:
https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-local-tunnel
After that's complete, use `pnpm tunnel`!