Skip to content
This repository has been archived by the owner on Jul 26, 2024. It is now read-only.
/ qnalert Public archive

qnalert helps to notify teams of VEX Robotics Q&A responses.

License

Notifications You must be signed in to change notification settings

Battlesquid/qnalert

Repository files navigation

qnalert

Utility to alert users when a VEX Q&A has been answered. Subscribe to Q&A notifications by joining the Unofficial VEX Nexus discord server.

Setup

env

In order to run qnalert, you need a .env file that contains the following

  • DISCORD_BOT_TOKEN: A discord bot token, which you can obtain by making a new application here
  • FIREBASE_AUTH: A firebase service account key.
  • PROD: Should be true or false depending on whether you want to use a development config or a production config.

Configuration

Development and production configs go in devconfig.json and config.json respectively (at the root of the project). Each given category should have a Discord channel ID. See the config in this project for more details.

Running

Node

Place the .env file in the root directory of the project.

npm i
npm run start

Docker

docker run --env-file /path/to/.env battlesquid0101/qa

About

qnalert helps to notify teams of VEX Robotics Q&A responses.

Resources

License

Stars

Watchers

Forks

Packages

No packages published