https://github.com/rahulsm20/broccoli-bot

A full stack application that helps live streamers enhance user engagement by streamlining user song requests, adding, editing commands and other integrations.
https://github.com/rahulsm20/broccoli-bot

docker docker-compose gcp gin-gonic go react redis redux-toolkit typescript vite

Last synced: 4 months ago
JSON representation

A full stack application that helps live streamers enhance user engagement by streamlining user song requests, adding, editing commands and other integrations.

• Host: GitHub
• URL: https://github.com/rahulsm20/broccoli-bot
• Owner: rahulsm20
• Created: 2024-03-20T14:15:10.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-12T13:28:11.000Z (6 months ago)
• Last Synced: 2025-01-12T14:31:00.306Z (6 months ago)
• Topics: docker, docker-compose, gcp, gin-gonic, go, react, redis, redux-toolkit, typescript, vite
• Language: TypeScript
• Homepage: https://broccoli-bot.vercel.app
• Size: 13.7 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Broccoli Bot 

Free, open source and distributed bot for twitch streamers that provides hassle free integration with multiple music streaming platforms.

## How to use

- Login with Twitch

- Login with your Spotify

- Default commands

  - !sr

    - function: adds a new song from the queue

    - params (any one)

      - song and artist name

      - spotify link

    - example: !sr <>

  - !rm - remove requested song

    - function: removes your latest requested song from the queue

    - params: none

## Run locally

- Client

  - Setup env variables based on the .env.example files

  - ```

    cd client

    ```

  - Run client

    ```

    npm run dev

    ```

- Server

  - Setup env variables based on the .env.example files

  - ```

     cd server

    ```

  - Download dependencies

    ```

    go mod download

    ```

  - Run server

    ```

    air

    ```

    (or)

  - Run using Docker

    ```

    docker build -t broccoli-api .

    docker run -p 3000:5000 broccoli-api

    ```

### Tech stack

- React + Vite + Typescript

- Go + Gin

- Redis

- Docker

- GCP (Cloud Run, Cloud Engine)

### System Design

![system-design](https://github.com/user-attachments/assets/31797fe7-d704-477f-afc2-fc0b574cca94)

### Possible Future Features

- [ ] Multi-source requests

- [ ] Ability to add new commands and edit existing ones

- [ ] Request Analytics

- [ ] Plug and play services

- [ ] Integration with Youtube & Kick