/oceny-backend

Discord bot that sends notifications when class gets new grades in Vulcan e-register

Primary LanguageJavaScriptGNU Affero General Public License v3.0AGPL-3.0

oceny-backend

Self-hosted webhook/bot to monitor changes in class grades on VULCAN UONET+ e-register.

Preview

Discord screenshot

See also

Web frontend: oceny-frontend-v2

Installation

Standalone

Requirements:

  • node.js 18 or later

Installation:

  • Clone the repository and cd into it:
git clone https://github.com/kabuspl/oceny-backend
cd oceny-backend
  • Copy .env.example to .env and customize it to your needs:
cp .env.example .env
  • Install packages:
npm install
  • Start program:
node .

Docker

Requirements:

  • docker with docker compose
  • system running on amd64 or arm64 cpu

Installation:

  • Clone the repository and cd into it:
git clone https://github.com/kabuspl/oceny-backend
cd oceny-backend

or download docker-compose.yml:

wget https://raw.githubusercontent.com/kabuspl/oceny-backend/master/docker-compose.yml
  • Modify docker-compose.yml to your needs.
  • Start container:
docker-compose up -d