jack073/repo-finder-bot

Find the best repos to contribute to, right from Discord!

repo-finder-bot

Find the best repos to contribute to, right from Discord!

Add to your server

FAQs

• Hmm. What's this?

This is the Repo Finder Bot, a bot designed to help people find good GitHub repositories to contribute to.

• How does it work?

Simple. Whenever you execute the rf.repo [topic] command in your server, the bot uses the GitHub API to find a good repository matching the topic and then send an array of details related to it.

You can also search for multiple topics, eg: rf.repo [topic1] [topic2].

You can even search repos of specific languages and topics using the rf.repolang [languages] [topics] command.

• What sort of details?

A whole array of details, including basic info ranging from the amount of stars and forks to the latest issues contributed to the repo.

Here's an example:

• Why are there no slash commands?

There was a slight trouble trying to fetch data using slash commands but don't worry, slash commands will be added soon!

• Why is the code so bad?

It works.

I'll fix it.

• Cool bot, can I add it to my server?

Of course you can! Just click this link and select the server of your choice.

• How can I contribute?

Just check out the Issues pane for potential issues and submit a PR to solve them. Of course, you can always submit regular PRs not linked to an issue and I'd be happy to accept them!

• How do I run the bot myself?

1. Clone this repository
2. Create a Discord bot token from here
3. Create a GitHub personal access token from here (Make sure to copy it immediately! You "lose" it once you refresh or close the tab)
4. Make a new file called .env inside the repo folder and paste the below code block in the file

GH_TOKEN="[paste Github token here]"
TOKEN="[paste Discord bot token here]"
DEV_GUILD=[paste your bot testing server ID here]

5. Run pip install -r requirements.txt to install packages. You'll require Python 3.6 or better
6. Once that's done, run the bot by executing python3 main.py in the terminal

If you aren't sure how to obtain your server ID, check out this article

If you get errors related to missing token environment variables, run source .env

Icons made by Freepik from Flaticon.