Skip to content

Latest commit

 

History

History
78 lines (67 loc) · 2.61 KB

README.md

File metadata and controls

78 lines (67 loc) · 2.61 KB
Raw

Oqix logo

OqixTS

Discord BOT intended for FIT@FI server.

Build Status GitHub last commit Latest GitHub tag Latest GitHub tag

OqixTS is a bot used in FIT@FI discord. This bot has following functionalinty:

  • Verify users
  • Print out information how many credits you will receive for course recognition
  • Prune spam messages
  • Announce message
  • Restart
  • Whoami - prints user info
  • Whois - print info about user

🖥️ Development setup

This app uses NodeJS to setup dev environment use npm and run following command:

npm i

App expects some environment variables to set them you can create .env file and enter following:

DISCORD_TOKEN=<BOT_TOKEN>
CLIENT_ID=<APPLICATION_ID>
GUILD_ID=<SERVER_ID>

To get bot token you have to create bot first. How to get server id and application id you can find here.

Let bot join the server entering following url in the browser:

https://discord.com/api/oauth2/authorize?client_id={CLIENT_ID}&permissions=0&scope=bot%20applications.commands

Next run the app:

npm run start

🐳 Docker setup

This app uses docker for deployment you can build container by running:

docker build -t oqix .

For running this app in container it is suggested to setup environment variables manually running:

export DISCORD_TOKEN=<BOT_TOKEN>
export CLIENT_ID=<APPLICATION_ID>
export GUILD_ID=<SERVER_ID>

Then run the app in container using:

docker run -it -e DISCORD_TOKEN=$DISCORD_TOKEN -e CLIENT_ID=$CLIENT_ID -e GUILD_ID=$GUILD_ID oqix:latest