Skip to content

A Discord bot used for the Wintec Information Technology Student server.

License

Notifications You must be signed in to change notification settings

Zerrissen/Wintec-IT-Bot

Repository files navigation

Wintec IT Bot

GitHub repo size GitHub release (latest by date) GitHub issues

Note: This bot and its authors are not directly affiliated with, nor managed by, Wintec or Te Pukenga, and do not represent their views or policies. This is designed for educational and recreational purposes only.

What is this?

This is a discord bot used by Wintec (Waikato Institute of Technology) students to automate the majority of their server features. This bot is designed to automate student verification, role assignment, moderation, and more!

It is being designed and developed by the students, for the students; present, past, and future.

Installation

There are two ways to deploy this bot. The first, and easiest way is to deploy the docker container:

docker pull zerrissen/wintec-it-bot:latest

docker run -p 127.0.0.1:3000:3000 -e TOKEN=<TOKEN> -e CLIENT_ID=<ID> -e MAIL_USER=<USER> -e MAIL_PASS=<PASS> -e POSTGRES_URL="<URL>" <image_name>

To install and setup this bot yourself, you require the following dependancies:

  • Node version >20.0.0
  • npm version >9.6.5

You can then clone the repository

git clone https://github.com/zerrissen/wintec-it-bot

Or download the source directly from the latest release here

You will also have to set up the following environment variables:

  • "TOKEN" (Bot token)
  • "POSTGRES_URL" (PostgreSQL connection string)
  • "CLIENT_ID" (Bot user ID)
  • "MAIL_USER" (Email address for the bot. We use Zoho mail)
  • "MAIL_PASS" (Bot email account password)

These variables should be set in a .env file in the root file of the repository.

Open the projects base directory in your terminal and run install the npm packages required:

npm i

And that's it! You can now run the bot with:

node .

Contributers

The Wintec IT Student server wouldn't be possible without contributions from various people. Many thanks to the following!

Bot contributers:

Server contributers:

License

This repository is licensed under the GNU Affero General Public License v.30. Permissions of this strongest copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. When a modified version is used to provide a service over a network, the complete source code of the modified version must be made available.

Read more here

About

A Discord bot used for the Wintec Information Technology Student server.

Resources

License

Stars

Watchers

Forks

Packages

No packages published