HackBot
HackBot copied to clipboard
A Discord Bot to notify users about the upcoming hackathon by getting data from various websites.
HackBot 🔥
HackBot is a Discord Bot
that notifies hackers, developers
about upcoming hackathons
.
The bot uses the scraped data from MLH, Devfolio, Devpost and HackerEarth to notify users about new hackathon as soon as it is listed on the website. Users can also see all the hackathons listed on site in discord itself. (Support for other websites to be added soon)
HackBot currently serves 50+ discord servers with 10000+ members!
Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of
Python
- You have a
<Windows/Linux/Mac>
machine.
Installing HackBot
To install HackBot, follow these steps:
- First move to the HackBot folder
- Run these commands
Linux and macOS:
python -m pip install -r requirements.txt
Windows:
py -m pip install -r requirements.txt
Using HackBot
To use HackBot, follow these steps:
- Move to the HackBot folder
- Run the following command
python bot.py
HackBot Commands
;hack notify <channel_name>
Assign a channel for upcoming hackathons notification
;hack web <website_name>
Fetch all hackathons listed on website.
Supported websites:
- MLH
- Devfolio
- Devpost
;hack unsub
Unsubscribe for upcoming hackathon notifications.
;hack issue "Feature/Issue title" "Feature/Issue description"
Report any issue or request any feature
Roadmap
- [x] Deploying the Discord Bot on Heroku
- [ ] Commands for users to retreive hackathon based on date
Issues, Bugs, Features
- Have you encountered any issue while using the bot, tell us by creating an issue.
- Want some more features to be implemented, look no further than the issues section.
Contributing to HackBot
To contribute to HackBot, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Push to the original branch:
git push origin <project_name>/<location>
- Create the pull request.
Alternatively see the GitHub documentation on creating a pull request.
Contributor
Contact
If you want to contact me you can reach me at [email protected]
License
This project uses the following license: MIT.