Home

queuerrr is a simple, API-first queueing system for streamers. It's geared towards streamers who can do software development since it's API-first, but anyone can use it. It's meant to be deployed to Vercel but you can run it on a VPS too.

This documentation will go through how you can set this up for yourself.

While I built this for my Twitch streams, it is streaming platform-agnostic, and you can use it on any streaming platform that allows you to write chatbots, or has something like channel point redemptions.

Fork the repository or click "Use template"

Forks will allow you to pull in upstream changes, while "use template" will give you a clean slate with no commit history, and you won't be able to easily pull in upstream changes. Learn the difference here.

Make code changes

You can make code changes to update the branding to be more suitable for your stream. See CONTRIBUTING.md for how to run the project.

You may also want to update the commands section in case your commands are different than mine.

Tech stack

The project is a Next.js project intended to be hosted on Vercel. It uses their Go runtime (currently in beta) for serverless endpoints.

• Back-end is serverless API endpoints (found in ./api) written in Go lang
• Database is Postgres, which is used to persist your data
• Front-end is Next.js (React) with TypeScript and Tailwind CSS

Deploy to Vercel

Link the repository

You'll need to sign up for Vercel, link your Github account and your fork or copy of the repository, and choose a name. Mine is hosted at https://queuerrr.vercel.app but you can maybe name it something like https://justinfan123-queue.vercel.app (where justinfan123 would be replaced by your username).

Add environment variables

• POSTGRES_CONNECTION_URL: A Postgres connection string. You can use any Postgres service you like for this.
• AUTH_TOKEN: A generated string which acts as an API token so you can modify your queue via the API.

Run the migrations in your Postgres SQL editor

The migrations are in ./scripts/sql. Run them in order manually.

Trigger a build

In the Vercel dashboard, trigger a build once you've added your environment variables. Your queue should now be ready to use.

🚀 You're ready to go!

Once your deployment is successful, you should be ready to go. Read the API documentation.