Git Product home page Git Product logo

bb-discord-announcer's Introduction

Blackboard Discord Announcer

A Blackboard bot for fetching and displaying Blackboard announcements to your Discord server. We currently support:

NOTE: Does the bot work with your schools Blackboard? Let us know!

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. We also have a Discord server to chat regarding development, help setting up the bot or general discussion, see this link.

You can check out and explore the Blackboard Discord bot here.

Prerequisites

You need Java 11 and Maven to be able to contribute to the project.

Setup Discord Bot

You can use and test the bot on the Discord server, but if you want to create your own Discord bot you can follow this guide. You need the Discord bot token as well as the Discord channel ID for the next section.

Application Configuration

For the Blackboard bot to work, you need to copy the application.properties.template to application.properties. The file holds the required values for the bot to work. A snippet template of the file is shown below. This file should NEVER be pushed to the repository or shared with anyone as it holds private information. Only have this locally.

### NTNU BlackBoard credentials ###
username={BLACKBOARD_AUTH_USERNAME}
password={BLACKBOARD_AUTH_PASSWORD}

# How many minutes to wait to check for new announcements
interval=60

### Bot ###
#https://discordapp.com/channels/{server_id}/{channel_id} (from discord web app)
channel_id={CHANNEL_ID_LOCATED_IN_URL_OF_SELECTED_DISCORD_SERVER}

# Token for your bot (from Discord Developer Portal)
token={DISCORD_BOT_TOKEN}

Built With

  • Java 11 - Language and version used
  • Maven - Dependency Management
  • JDA - Java Discord API

Contributing

Contribution guide will come shortly.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

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.