Bbnotify

🚧 BB Notify 🚀 Work in progress... 🚧

🎯 About

Describe your project

✨ Features

✔️ Automatically logs into BlackBoard and gathers course information;
✔️ Sends todo's and homerworks to discord;
✔️ WIP: Gathers homework files (PDF's, DOCX's) and lists on discord with a direct link;

🚀 Technologies

The following tools were used in this project:

✅ Requirements

Before starting 🏁, you need to have
Yarn and Node installed.
Git Is optional, but recommended

🔧 Settings

Setting up BlackBoard

  # To setup your BlackBloard settings change the value from .envExample
  nano .envExample

  # Now rename it to .env or just create a new one
  mv .envExample .env

  # If you are using windows, just open .envExample, change to your information and rename it to .env

Setting up the discord webhook:

Go to your discord server, and click {Edit channel} where you want to receive updates
Navigate to Integrations and create a new Webhook.
You webhook should look like this: https://discord.com/api/webhooks/12345678912356789/32QoUL-6GL4H31MM2otK-Llw86hD5VDJ6WjjVJem4D35LpqdasdaadsM0MOXqzJmZP3lm
- The first part (12345678912356789) is your Webhook ID
- The second part (32QoUL-6GL4H31MM2otK-Llw86hD5VDJ6WjjVJem4D35LpqdasdaadsM0MOXqzJmZP3lm) is your webhook Token!
Navigate to the project folder > config and open discord.json

cd bbnotify
cd config
nano discord.json

# If you're using windows, just open the discord.json file

Replace everything by your liking, remember to paste your webhook id and token!
That's it!

🏁 Starting

# Clone this project
# Download repository if you don't have GIT installed
$ git clone https://github.com/nodgear/bbnotify

# Access
$ cd bbnotify

# Install dependencies
$ yarn --production=false

# Run the project
$ yarn start

# For developer mode:
# First install the developer dependencies
$ yarn install --production=false

# Now you can start devmode by running
$ yarn dev

# In developer mode you can see everything BB Notify is doing in real time and changing files will automatically restart the server.

📝 License

This project is under license from GNU GPL 3. For more details, see the LICENSE file.

Made with ❤️ by Nodge