🌟🦋😈⛔🔎🙋

* 🙈

* feat: db support 🤖

* feat: 🌟

* 🐍

* feat: 🌟

* feat: 🌟

* feat: 🌟

* feat: 🌟

* feat: 💫

* feat: 🌟

* feat: ✨

* feat: ✨

* update: 🙋

* feat: 💫

* feat: 💫

* feat: 🔍 Star Status Check

* feat: check ⭐ status

* update: requirements.txt 📃

* update: readme ✔️

* 🚫🐛

.env.example

@@ -1,39 +1,68 @@
+#*************#
+#** DISCORD **#
+#*************#
+
 # Discord 'App Token' and 'Client ID'
+# https://discord.com/developers/applications
 TOKEN=
 CLIENT_ID=
 
-# The target user/repo for the bot functions
-REPO_OWNER=
-GITHUB_REPO= 
-
-# GitHub Oauth 
-# set the callback to `http://localhost:8080/authorize` in the app portal
-DOMAIN=http://localhost:8080
-GITHUB_CLIENT_ID= 
-GITHUB_CLIENT_SECRET=
-SECRET_KEY=
-
-# Discord 'Role ID' (to give once the repo has been starred)
-ROLE_ID=
+# The 'Role ID' -> The role to give once the repo has been starred
+# The 'Server ID' -> The server where the bot is going to be used
+# The 'Channel ID' -> The channel where the bot is going to post 
+ROLE_ID= 
+GUILD_ID= 
+CHANNEL_ID= 
 
-# MongoDB database 
-MONGO_HOST=mongodb # default: mongodb, put "localhost" if you don't use docker
-MONGO_DATABASE=mongodb # default: mongodb
+# Automatically check if the verified users removed their star on the repo
+# then remove their role on discord and update their status in the database
+# The delay is set in seconds, minimum 5 minutes if not set it will default to one hour
+# examples: 300 = 5 minutes, 3600 = 1 hour, 86400 = 1 day, 604800 = 1 week 
+AUTOMATIC_CHECK=True
+AUTOMATIC_CHECK_DELAY=3600 
 
 # Custom "Useful links" Command 
-# DO NOT LEAVE EMPTY
-COMMAND_NAME=hyperlinks #lowercase only
-COMMAND_DESCRIPTION=🌐 Useful Links
-COMMAND_EXTENDED_DESCRIPTION= - Quick access to **GitHub**, **Discord**, **YouTube** and **Reddit**
+# NOTE: The 'COMMAND_NAME' only supports lowercase
+# REQUIRED: the bot will crash if these are not set
+COMMAND_NAME=hyperlinks
+COMMAND_DESCRIPTION=Useful Links
+COMMAND_EXTENDED_DESCRIPTION=- 🌐 Quick access to **GitHub**, **Discord**, **YouTube** and **Reddit**
 
-BTN1=GitHub
+BTN1=💻GitHub
 URL1=https://github.com/
 
-BTN2=Discord
+BTN2=💬Discord
 URL2=https://discord.com/
 
-BTN3=Youtube
+BTN3=📺Youtube
 URL3=https://youtube.com/
 
-BTN4=Reddit
+BTN4=📝Reddit
 URL4=https://reddit.com
+
+#******************#
+#** GITHUB OAUTH **#
+#******************#
+
+# The target user/repo for the bot functions
+REPO_OWNER=
+GITHUB_REPO= 
+
+# GitHub Oauth 
+# https://github.com/settings/apps
+# set the callback to `http://localhost:8080/authorize` in the Github Developer settings
+DOMAIN=http://localhost:8080
+GITHUB_CLIENT_ID= 
+GITHUB_CLIENT_SECRET=
+
+# Set to a random secret key to secure the oauth (mix of letters, numbers, and symbols)
+SECRET_KEY=SecretKey
+
+#**********************#
+#** MONGODB DATABASE **#
+#**********************#
+
+# Host default: mongodb, use "localhost" if you don't use docker
+# Database default: mongodb
+MONGO_HOST=mongodb 
+MONGO_DATABASE=mongodb

.gitignore

@@ -3,6 +3,9 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+#tests scripts folder
+tests/
+
 # C extensions
 *.so
 

README.md

@@ -1,23 +1,17 @@
 # Discord-GitHub-bot
 
 ## To Do:
--  💫github_oauth.py: 
-   - make check for star status of the specified repo (using the user's bearer tkn)
-   - add db entry
 
-- 🤖 bot.py: 
-   - add db support 
-   - when auth -> timeout 1min -> check if db entry was made -> update verified user status -> update role
-
-- 😈 add "admin" command to force re-verification and update roles assignments
-- 🔎 Implement a periodic check of the starred users or something like that
-- 🪓 Split the user validation commands from the other github menu?
-- 🖲️ Add functions to the bot (<ins>5 buttons max</ins>)
-  - example:
-  ![image](https://github.com/fuegovic/Discord-GH-bot/assets/32828263/86b90c99-48f4-4c13-9b96-df552b9b9466)
-- 📝 Documentation, how to use and configure
-- ... 👀
+- 📚 Documentation, how to use and configure
+- ~~⛔Remove role if the user validation shows `starred_repo: false`~~
+- ~~🦋 Make it pretty (organize the slash commands)~~
+- ~~🪓 Split the user validation commands from the other github menu?~~
+- ~~😈 add "admin" command to force re-verification and update roles assignments~~
+- ~~🔎 Implement a periodic check of the starred users or something like that~~
+- ~~🫵 Make the bot assign a role~~
+- ~~✅ Verify the users that used the github oauth~~
 - ~~📃 Make `requirements.txt`~~
 - ~~🐋 Put everything in a docker container for easier deployment~~
 - ~~🖼️ Better page for successful login~~
 - ~~🤔 Make sur the API handles multiple users using the bot at once~~
+- ... 👀