javadiscord/lj-discord-bot

The Discord bot powering the 〜 Love Java ღ server

〜 Love Java ღ Server Discord Bot

Welcome to the 〜 Love Java ღ Discord bot repository! This bot is an integral part of the 〜 Love Java ღ Discord Server, created and maintained by our wonderful community of Java enthusiasts. We encourage everyone to join in and contribute to this project, as it serves multiple purposes:

Project Goals

1. Learning Experience: We aim to provide developers with a hands-on learning experience by working on a "real-world" project. The bots codebase offers a practical playground for honing your programming skills, especially in Java.
2. Open-Source Contributions: We believe in the power of open-source contributions. By actively participating in this project, you can gain exposure to open-source development practices and foster collaboration with like-minded individuals.
3. Quality-of-Life Features: The bot serves as a valuable asset to our Discord server, enhancing the overall user experience by providing specific quality-of-life features. It's our way of giving back to the Java community.

Setup

This project uses the following tech:

• pre-commit
• Java 21
• Gradle version 8.5

You must have pre-commit installed on your machine. Once that's installed, in the root of the project run pre-commit install to install the git hooks.

To build the project simply run gradle build and this will package everything up.

Before running the application (e.g. java -jar build/libs/Java-Discord-Bot.jar) you must set the following environment variables:

1. BOT_TOKEN this is your Discord Bot Token
2. CHATGPT_API_KEY this is your ChatGPT API key
3. TENOR_API_KEY this your Tenor API Key
4. RAPID_API_KEY this is your RapidAPI key

How to Contribute

Contributions are highly encouraged, regardless of whether it's a minor bug fix or a major feature enhancement. To get started, please follow these steps:

1. Fork the Repository: Click the "Fork" button in the top-right corner of this repository. This will create a copy of the project in your GitHub account.
2. Create a Dedicated Branch: Before making any changes, create a dedicated branch in your forked repository. This branch should be named appropriately to reflect the nature of your contribution (e.g., feature/new-command, bugfix/issue-123).
3. Implement Changes: Make your desired changes in the dedicated branch. Ensure that your code adheres to the project's coding guidelines and style conventions. If applicable, include tests to validate your modifications.
4. Submit a Pull Request: Once you're satisfied with your changes, submit a pull request (PR) back to this repository. In your PR description, provide a clear and concise summary of your changes, along with any relevant details that would help reviewers understand your contribution.
5. Collaborate and Iterate: Be open to feedback and collaborate with the community to refine your contribution. We appreciate your effort and look forward to working together to improve the bot.

Get in Touch

If you have questions, suggestions, or need assistance, please feel free to reach out to us on the 〜 Love Java ღ Discord Server. We're here to support you in your journey of contributing to this exciting project.

Thank you for your interest in the 〜 Love Java ღ Discord bot project. Together, we can make it even better and strengthen the Java community.