Code Monkey home page Code Monkey logo

verify-bot's Introduction

University of Southampton verification Discord bot

A bot to interact with the global verification API to verify users in University of Southampton related discord servers.

How to set up the bot

  1. Invite the bot
  2. Run /setup specifying your verified role (you can learn more about creating a verified role here)
  3. Enjoy easy verification of your members!

How it all works

With this service users can verify themselves once on the website and then never have to verify again! We store who is verified and who isn't in our database and then whenever you run /verify or join a server we will give you that server's verified role!

Commands

/verify

Verifies you or tells you how to verify.

/re-verify

Will batch verify everyone on the server. Admin only

/setup

Sets up the bot. Admin only

Run Locally

Make sure you have rust installed. You can check this with cargo -V

Clone the project

  git clone https://github.com/ecss-soton/verify-bot.git

Go to the project directory

  cd verify-bot

Configure the environment variables. See Environment Variables

Start the bot

  cargo run --release

Environment Variables

Create a .env file at the project root and fill it with the following variables

A list of these can also be seen in .env.example

DISCORD_TOKEN="Your Discord Token"
# This is only necessary if you want to only update the guild commands and not the global ones.
TEST_GUILD_ID="Guild Id"
# Contact the ECSS web officer to get access to an API Key
API_KEY="The API key for the Soton verify service"
API_URL="The URL to that API"
DISPLAY_URL="The URL to display to users for verification"

Docker image

TODO Add docker image link with dockerfile

verify-bot's People

Contributors

miam-miam avatar ortovoxx avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.