diff --git a/README.md b/README.md index 74c6f25..2b450f9 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,15 @@ **🤖 Nvidia Stock Bot** - A bot that alerts you in real-time about **Nvidia RTX FE** GPU stock availability through Discord notifications. > [!NOTE] ->_The code was partially written and structured using a generative AI._ -> >_Github repo is a mirror of https://git.djeex.fr/Djeex/nvidia-stock-bot. You'll find full package, history and release note there._ +> +>_LLM used for bugs check and languages files generation._ + +## 🖼️ Screenshots + +
+ Nvidia Stock Bot - screenshots +
## 📌 Table of Contents @@ -21,8 +27,8 @@ - [🐳 Docker Installation without cloning the repo (quick)](#-docker-installation-without-the-repo-quick) - [🐙 Docker Installation with the repo (developer)](#-docker-installation-with-the-repo) - [🐍 Python Installation (developer)](#-python-installation) -- [🖼️ Screenshots](#-screenshots) - [🐞 Common issues](#-common-issues) +- [❓ How it works](#-how-it-works) - [🧑‍💻 Contributors](#-contributors) ## ✨ Features @@ -150,7 +156,7 @@ git clone https://git.djeex.fr/Djeex/nvidia-stock-bot.git ```sh export DISCORD_WEBHOOK_URL="https://your_discord_url" -export COUNTRY=€ +export COUNTRY=US export PRODUCT_NAMES=RTX 5080, RTX 5090 export DISCORD_ROLES=<@&12345>, <@&6789> export REFRESH_TIME="60" @@ -164,19 +170,19 @@ export PYTHONUNBUFFERED=1 python nvidia-stock-bot.py ``` -## 🖼️ Screenshots - -
- Nvidia Stock Bot - screenshots -
- ## 🐞 Common issues Error when trying to reach product API url : -- `API_SKU_URL` may be wrong +- Custom `API_SKU_URL` may be wrong - Your IP may be blacklisted by nvidia. Try to use a VPN. - nvidia API may be down +## ❓ How it works + +
+ Nvidia Stock Bot - screenshots +
+ ## 🧑‍💻 Contributors Thanks for their contributions: diff --git a/assets/img/nvidia-stock-bot-discord.png b/assets/img/nvidia-stock-bot-discord.png index 57a3dd7..f712cd9 100644 Binary files a/assets/img/nvidia-stock-bot-discord.png and b/assets/img/nvidia-stock-bot-discord.png differ diff --git a/assets/img/nvidia-stock-bot-scheme.svg b/assets/img/nvidia-stock-bot-scheme.svg new file mode 100644 index 0000000..f216d9e --- /dev/null +++ b/assets/img/nvidia-stock-bot-scheme.svg @@ -0,0 +1,5 @@ + + +Updating variables(defined in theconfiguration)Discord WebhookURLExec frequencyCountryProducts NamesSetting localizationCountryError if incorrectvariable settingsXDiscord rolesLocaleslocalization.jsonCurrencyLanguageLocalizedAPI URLsCurrencylanguages.jsonTranslatedvariablesIf errorFallback to USXIf errorFallback to englishXenv_config.pyMapping rolesto product namesProducts NamesDiscord rolesProduct 1Product 2Role 1Role 2Error if numbers not matchingXPrinting all variablesvalues in logsStart the scriptmain.pyLoop product checkergpu_checker.pyQuerying Nvidia productsvia the previously configured API URLLocalizedProduct APIAPI response with a list of product information and saved SKUs/UPCsJSONIf different SKU?If similar SKU?Discord notificationVia the webhook urlDiscord WebhookURL!Stock APIBuilding the Stock API URLAPI_URLSKU+=Querying Nvidia's inventory via the previouslyconfigured API URLAPI_URLAPI responsewith statusSKUUPCLooking for in responseJSONIf out of stock If previoulsy in stockRecording the "out_of_stock" statusIf in stockRecording the "in_stock" statusDisplaying status in the log historyDiscord notificationVia the webhook urlURL du webhookDiscord!????UPC If previoulsy in stockIf previously out of stock??If previously out of stockDiscord notificationVia the webhook urlURL du webhookDiscord!JSONBuilding discordNotificationDiscord WebhookURLCurrencyDiscord rolesProducts NamesTranslatedvariablesnotifier.pyLocalizedStock APILocalizedProduct URLNvidia Stock Bot - v4.0Exec frequency \ No newline at end of file