An open API service indexing awesome lists of open source software.

https://github.com/alexandergrooff/usc-signal-bot


https://github.com/alexandergrooff/usc-signal-bot

Last synced: 9 months ago
JSON representation

Awesome Lists containing this project

README

          

# USC Signal Bot

## Overview

This is a Signal messenger bot that can process commands from chat, deployed in Kubernetes.

It's used to make reservations at the USC gyms.

## Usage

To use the bot, you need to register it as a device with Signal. To do this you put the `signal-api` service in `MODE=normal` and go to http://localhost:8080/v1/qrcodelink?device_name=signal-api.
Register the device with Signal by scanning the QR code with the Signal app on your phone.

When you're done, put the `signal-api` service in `MODE=json-rpc` and restart it.

## Development

### Prerequisites

- Python 3.12
- Docker and Docker Compose
- direnv