/CodeGrind-Bot

Elevate your LeetCode experience with CodeGrind Bot: Compete on leaderboards, retrieve LeetCode problems, and track your progress! ๐Ÿš€

Primary LanguagePythonOtherNOASSERTION


Logo

CodeGrind Bot

Get ready for an epic coding showdown with the CodeGrind Bot! Compare daily, weekly and all-time stats and conquer LeetCode together in the ultimate quest for coding glory.

Invite CodeGrind Bot to your Server ยป

View Full List of Commands . Report Bug . Request Feature

Contributors Issues License

Table Of Contents

About the Project

CodeGrind Bot is a Discord bot designed for LeetCode enthusiasts. Using the LeetCode API, it allows users to track and compare your coding stats for daily, weekly, and all-time periods, promoting friendly competition and continuous skill progression.

Created with discord.py, CodeGrind Bot transforms your programming journey into an inclusive, interactive, and engaging experience. It's an open-source project, making contributions from anyone in the community more than welcome - your input can help it grow, improving its capabilities and user-friendliness.

Please note: while the bot uses the LeetCode API for data, it's not officially affiliated with LeetCode. Proper respect for the copyrights and terms of use of LeetCode is expected from all users.

Join us on this coding showdown. Invite CodeGrind bot to your server today, and let the coding quest begin!

Built with

CodeGrind Bot makes use of several libraries. Key dependencies include:

  1. discord.py: A modern, Pythonic library utilized for interactive handling of the Discord API.

  2. topggpy: The official Python library that allows CodeGrind Bot to interact effectively with the top.gg API.

  3. Beanie ODM: An asynchronous Python object-document mapper (ODM) for MongoDB. Data models are based on Pydantic.

  4. MongoDB: An open-source, document-oriented NoSQL database known for handling high volume data storage.

Each of these components is crucial in ensuring the smooth operation, efficiency, and utility of CodeGrind Bot.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  • If you have suggestions, feel free to open an issue to discuss it, or directly create a pull request.
  • Create an individual PR for each suggestion.

Creating a Pull Request

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Setting up a Testing Version of the Bot

The steps for setting up a testing version of the bot can be found in our Setup for Local Testing wiki page.

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Acknowledgements