Skip to content

Latest commit

 

History

History
69 lines (53 loc) · 3.12 KB

README.md

File metadata and controls

69 lines (53 loc) · 3.12 KB
Raw

Pretzel - Porting MLS to Discord.

Pretzel is a Discord bot that ports the My.LaSalle course offerings page into a Discord bot, offering seamless class selection integration within Discord servers. Powered by web scraping technology, Pretzel autonomously retrieves real-time data from the university's official listing page, ensuring up-to-date information on available classes for the current trimester. Built with efficiency in mind, Pretzel provides users with a technical edge by delivering comprehensive course details directly to their Discord channels. Embrace the convenience of Pretzel and revolutionize your class registration experience today. Step-by-step guide on how to install your project.

Installation

Clone the repository

git clone github.com/zelkim/pretzel

Navigate to the project directory

cd pretzel

Install dependencies

npm install

Setup .env

Only one environmental variable is needed for this project:

BOT_TOKEN=your_discord_bot_token

You can read on how to setup your own instance of the bot here.

Run the application

node app.js

Usage

Bot commands:

!open <course code>
!class <course code> <class ID or section>

COMING SOON: GE Filter, Campus Filter, College Filter, XYZ filter

Contributing

Thank you for considering contributing to Pretzel! Contributions are highly valued and help improve the bot for everyone. Whether you want to report a bug, suggest a new feature, or contribute code, here's how you can get involved:

Bug Reports and Feature Requests:

If you encounter a bug or have an idea for a new feature, please open an issue on the GitHub repository. Be sure to provide detailed information about the bug or feature request, including steps to reproduce the issue if applicable.

Code Contributions:

  1. Fork the repository and create a new branch for your contribution.
  2. Make your changes and ensure they adhere to the project's coding standards.
  3. Test your changes thoroughly.
  4. Submit a pull request with a clear description of the changes you've made and the problem or feature they address.

Review and Feedback: Even if you're not contributing code directly, reviewing pull requests, providing feedback, and testing changes are valuable contributions to the project. Before contributing, please review the Code of Conduct to ensure a positive and inclusive community environment.

Thank you for helping make Pretzel better!

License

Pretzel is licensed under the Apache License 2.0. For further details about the Apache License 2.0, please visit Apache License 2.0.

Contact

Email: sean_robenta@dlsu.edu.ph Discord: @zelkim