Home

Twitch-chatbot-boilerplate

Table of contents

• About
• Caveats

About

Twitch-chatbot-boilerplate is a template for, well, twitch chatbots. You should only need to write your business logic (and might edit a few HTML/ejs files), deploy it and have a working bot running.

The boilerplate:

• comes with

  • Typescript
  • tmi.js
  • eslint
  • Jest
  • Prettier
  • .editorconfig
  • dotenv

• sets up an express server which

  • enables the authorization of the bot by the bot's twitch account easy
  • provides a /add route for streamers to use to invite the bot to their chat
  • provides a /remove route for streamers to use to kick the bot off their chat

• persists joined chatrooms over restarts

• takes care of refreshing the access token when needed

Architecture

To achieve this the boilerplate is devided in to parts:

1. the twitch-chatbot-boilerplate repo which depends on
2. the twitch-chatbot-boilerplate-core repo

This way even those that, for example, don't like Jest or Typescript can use their boilerplate of choise and import the magic initialize() function using the twitch-chatbot-boilerplate npm package.