OpenDevBot — Quick setup

Development only: This documentation and the local OAuth endpoints are for development and testing purposes only. The production-ready deployment is not available — do not use these instructions to run a public/production instance without additional hardening, configuration, and review.

1. Prerequisites

Node.js 22 or newer
npm
SQLite (included; required for application data)

2. Install

git clone https://github.com/SkullGaming31/OpenDevBot.git
cd OpenDevBot
npm install

3. Configure

Create a .env file (use .env.example as a guide) and set the required values, at minimum:

TWITCH_CLIENT_ID=your_twitch_client_id
TWITCH_CLIENT_SECRET=your_twitch_client_secret
ENVIRONMENT=dev
ENABLE_CHAT=true
ENABLE_EVENTSUB=false
PORT=8000

4. Start the bot (development)

npm run start

5. Add your Twitch token to the database

OpenDevBot provides an OAuth route that will exchange a Twitch authorization code and persist the token in the database. While the bot is running locally, visit the following URL (replace <CLIENT_ID> and <REDIRECT_URI> with your app values):

https://id.twitch.tv/oauth2/authorize?response_type=code&client_id=<CLIENT_ID>&redirect_uri=<REDIRECT_URI>&scope=user:read:email+chat:read+chat:edit

By default the project expects the OAuth callback at /auth/twitch/callback (see your configured redirect URI). After completing the OAuth flow the bot will persist the token into SQLite and, if configured, automatically join the broadcaster channel.

If you host the web app and want to add the token through the project's UI, use one of the links below depending on the token type:

Authorize (bot) — add bot token

Authorize (user) — add user token

6. Troubleshooting & notes

Ensure the email/username used in Git commits is associated with your GitHub account.
If you run into EventSub issues, set ENABLE_EVENTSUB=false until EventSub is configured.

Questions or help? Open an issue on the repository.