Victoria University of Wellington verification system for Discord

Go to file

Leon Bowie add9d37257 Update dependency eslint to v8.24.0 (#44 )		2022-09-24 18:20:10 +12:00
.github	Update github/codeql-action action to v2 (#25 )	2022-08-29 15:18:22 +12:00
.husky	style: cleanup code	2022-08-29 00:51:29 +12:00
.yarn	Update Yarn to v3.2.3	2022-08-28 09:16:04 +00:00
prisma	Working base code	2022-08-28 21:10:13 +12:00
src	fix: make sure user id is used	2022-08-29 17:56:41 +12:00
.dockerignore	Working base code	2022-08-28 21:10:13 +12:00
.env.example	Working base code	2022-08-28 21:10:13 +12:00
.gitignore	update gitignore	2022-08-28 21:09:21 +12:00
.prettierignore	initial	2022-08-23 18:44:06 +12:00
.yarnrc.yml	Update Yarn to v3.2.3	2022-08-28 09:16:04 +00:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2022-08-29 01:18:52 +12:00
Dockerfile	update dockerfile	2022-08-29 00:29:59 +12:00
LICENSE	Create LICENSE	2022-08-29 00:34:10 +12:00
README.md	style: add README	2022-08-29 01:22:35 +12:00
docker-compose.yml	style: add README	2022-08-29 01:22:35 +12:00
package.json	Update dependency eslint to v8.24.0	2022-09-24 02:05:21 +00:00
renovate.json	Add renovate.json	2022-08-23 06:44:21 +00:00
start.sh	Working base code	2022-08-28 21:10:13 +12:00
tsconfig.base.json	initial	2022-08-23 18:44:06 +12:00
tsconfig.eslint.json	style: cleanup code	2022-08-29 00:51:29 +12:00
tsup.config.ts	initial	2022-08-23 18:44:06 +12:00
yarn.lock	Update dependency eslint to v8.24.0	2022-09-24 02:05:21 +00:00

README.md

VicVerify

Discord verification system for Te Herenga Waka - Victoria University of Wellington.

About

This is a Discord bot that handles verification between Discord accounts and Vic uni accounts. It has the ability to verify students and staff separately and assign roles based on the verification. It is designed to be used by both university clubs and official course servers providing a painless and seamless verification system. This system was designed with privacy in mind with the Victoria Engineering Club not having access to any data and all processes are fully automated.

How to use

Verification

The verification process is fairly straightforward and only requires the user to have access to their university email.

Run /verify in Discord which begins the verification process, you will also need to provide if you are a student and your email address which ends in @vuw.ac.nz or @myvuw.ac.nz.
You will receive a verification code in your email in the following few minutes.
Run /verifycode <code> in Discord to verify your account which will then be synced across all servers.
Done!!!

To unlink your Discord account from your Vic account, run /unlink in Discord. This will remove all verification roles and after 1 years time delete all data related to your Discord account.

Server Administration

Server administration is originally handled by the bot but requires additional configuration. When the the bot joins the server it will create a Student and Staff role which will be used for verified users. These roles have no permissions and it is up to you to add those permissions. It is recommended to remove send messages from @everyone and instead require users to be verified in order to send messages.

If you these roles are not created please kick and re-add the bot to the server. If you do this once roles are created the bot will create new roles when it joins.

Development

This is a fully open-source project coordinated by the Victoria Engineering Club from at their discord found here. If you have any questions or suggestions, please feel free to contact us.

Requirements

The following tools and software are used for development of this service.

Docker
Node.js (v18)
Yarn (v3)

Installation

This will install all packages and commit hooks allowing local development.

yarn install

To deploy the full stack which is especially useful for testing, you can use the following command.

docker compose up -d