lucy/UntisBot
1
0
Fork 0
forked from Lea/UntisBot
Code Issues Pull requests Projects Releases Wiki Activity

Add readme

Browse source
This commit is contained in:
Jan 2020-12-03 20:33:01 +01:00
parent 7a4cb974cb
commit b8fd904b2e
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
readme.md Normal file
View file

@ -0,0 +1,15 @@
# Untis Bot
Simple bot that notifies you of timetable changes on Discord.
# Setup
- Clone the repository and CD into it
- `sudo npm install -g typescript` if you haven't already
- Type `tsc` to compile
- Create a `.env` file in the project's root with the following content:
SCHOOLNAME=Your school's name
USERNAME=Your username
PASSWORD=Your password
BASEURL=Your school's Untis URL, for example mese.webuntis.com
BOT_TOKEN=Discord bot token
CHANNEL=The channel ID that the bot sends messages to. Only supports DM channels right now.
- `node dist/index.js` to run the bot. You can use tools like `pm2` to automate starting and stopping.