HackRPI-DiscordBot2023

Welcome to the official GitHub repository for HackRPI Discord Bots! Over the past decade, HackRPI has grown into one of the most prestigious hackathons, providing a platform for innovation, collaboration, and creativity. As we celebrate this milestone, we invite you to be a part of this journey.

🎉 Join the Celebration!

We're thrilled to see the HackRPI community grow each year and are always on the lookout for fresh ideas and perspectives. Whether you're a seasoned developer, a design enthusiast, or someone who's just passionate about hackathons, there's a place for you here!

🤖 Our Purpose

The HackRPI Organizing Team, founded in 2014, has run RPI’s annual hackathon for the past 10 years. Running a large-scale hackathon such as this comes with many responsibilities, one of which is to create hackathon tools and manage the event discord. While the Technology team within the club has done a great job at this, scaling up for the 10th annual hackathon requires a large amount of work. This project aims to help the HackRPI Technology team by developing a discord bot to manage our event server and hackathon tools to be used throughout the event.

🖐 How Can You Contribute?

1. Bug Fixes: Spot an issue? Feel free to submit a pull request.
2. Feature Suggestions: Got an innovative idea for the discord bot? Raise an issue, and let's discuss it!
3. Documentation: Help make our documentation clearer and more comprehensive for future contributors.
4. Outreach: Share the project and gather feedback, helping us reach a broader audience.
5. Connect with Us: Reach out to us on Discord. If you are interested in contributing more to HackRPI, reach out to our organizing team on Discord and ask the technology team for tasks or any assistance.

🛠 Getting Started

Recommended Tools:

• Editor: Visual Studio Code
• GitHub Desktop: Download here
• Python: Download Python

Steps:

1. Clone the Repository:

   • Using GitHub Desktop, choose File > Clone repository and select the HackRPI repository. This will create a local copy on your machine.

2. Create a New Branch:

   • Once the repository is cloned, create a new branch in GitHub Desktop.
   • For features, use the naming convention: feature/your-feature-description.
   • For bugs, use the naming convention: bug/your-bug-description.

3. Implement and Commit Changes:

   • Make the necessary changes in your branch. Use Visual Studio Code or your preferred editor.
   • Add comments!!
   • Once done, commit your changes using GitHub Desktop.

4. Update with Main:

   • Before pushing your changes, ensure you have the latest version of main. In GitHub Desktop, pull the latest changes from the main branch and merge them into your branch.

5. Test Your Changes:

   • Ensure your design is responsive. Employ best practices for responsive design.

6. Push and Create a Pull Request:

   • Push your branch to GitHub using GitHub Desktop.
   • Then, visit the repository on GitHub's website and create a pull request. Write a description of the changes in the comment, and paste any relevant images showcasing updates. Our team will review, provide feedback, or merge your changes.

⏯️ How to Set Up Environment File

1. Create a .env file in your directory
2. Ask Project Lead for Discord token
3. In the file type 'DISCORD_BOT_TOKEN = replace_with_token'
4. Open bash and 'pip install python-decouple'
5. To use the token
   • In a python file import config by typing "from decouple import config"
   • Grab the token from the .env with "token = config("DISCORD_BOT_TOKEN")"
6. NEVER share the token and other details in the .env file!