{"id":22155654,"url":"https://github.com/onebeld/sparklescannerbot","last_synced_at":"2025-03-24T14:20:44.430Z","repository":{"id":196467692,"uuid":"696107183","full_name":"Onebeld/SparkleScannerBot","owner":"Onebeld","description":"Telegram chatbot that allows you to check sites for traffic, security, transmission and so on","archived":false,"fork":false,"pushed_at":"2023-12-18T14:05:21.000Z","size":71,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-29T19:16:03.707Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Onebeld.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-09-25T05:18:19.000Z","updated_at":"2023-12-14T13:52:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"72eac7ce-4f3f-4311-96c9-63dd807f1a5d","html_url":"https://github.com/Onebeld/SparkleScannerBot","commit_stats":null,"previous_names":["onebeld/n_i_kit_os","onebeld/sparklescannerbot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Onebeld%2FSparkleScannerBot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Onebeld%2FSparkleScannerBot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Onebeld%2FSparkleScannerBot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Onebeld%2FSparkleScannerBot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Onebeld","download_url":"https://codeload.github.com/Onebeld/SparkleScannerBot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245284741,"owners_count":20590309,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-02T02:19:13.744Z","updated_at":"2025-03-24T14:20:44.411Z","avatar_url":"https://github.com/Onebeld.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"![SparkleScannerBot](https://github.com/Onebeld/SparkleScannerBot/assets/44552715/a3b89a34-8fc3-4cac-a887-ef88b35f1241)\n\n# SparkleScannerBot\n\nA Telegram chatbot (codename *N_i_Kit_OS*) that allows you to analyze websites, as well as alert the user if there is a problem with the site.\nThe bot stores all saved links for hourly checking in its database,\nwhich has `user_id` and `link` columns in the `users` table.\n\nThis project was developed as part of the Information Systems Architecture discipline at the university (RSVPU).\n\nThe project was created by our team of three people:\n- [N-i-Kit-OS](https://github.com/N-i-Kit-OS) — project idea, demo version of the bot in Python, proposed functions (the codename of the project was his idea);\n- Onebeld (Dmitry) — creating all bot functions on Rust, documentation writing;\n- Beautiful Marina — creating a logo for the bot, creating a presentation, approving a name for the bot, bot testing.\n\n## Functions\n\n- Hourly checking sites for its availability, entered by the user;\n- Site Analysis:\n  - Displays the site's response code;\n  - Displays the site's response time;\n  - Checking for robots.txt;\n  - Check if sitemap.xml is available;\n  - Checks if an SSL certificate exists and, if it does, displays information about it.\n\n## More info\n\nInitially, the Python programming language was used for the bot. However, later we switched to Rust,\nas we can use it to create an efficient, secure and fast information system\n(We can consider that we used Python to create a demo of the bot).\n\nThe bot uses a **sqlite** database to store links. You need to create the database manually, as the bot ***cannot*** create them.\n\n## Getting started\n\nBefore you can compile the bot, you must have `rustup` (downloadable from the official Rust website) and Visual Studio with the C++ Application Development component on your system (you can find Visual Studio Build Tools if you don't want to install the IDE).\n\nTo compile the bot, use the command in the terminal:\n```shell\n# Compile the assembly with debug symbols\ncargo build\n\n# Alternatively, compile a clean, optimized build of the program\ncargo build --release\n```\n\nBefore running the bot, you must assign environment variables in your operating system.\nYou can insert this in a batch file for Windows or command files in Unix:\n```shell\n# Unix-like\nexport TELOXIDE_TOKEN=\u003cYour token here\u003e\nexport DATABASE_URL=\u003cYour url\u003e\n\n# Windows command line\nset TELOXIDE_TOKEN=\u003cYour token here\u003e\nset DATABASE_URL=\u003cYour url\u003e\n\n# Windows PowerShell\n$env:TELOXIDE_TOKEN=\u003cYour token here\u003e\n$env:DATABASE_URL=\u003cYour url\u003e\n```\n\nThen you have to run this bot from a batch (command) file, or run it from the command line. The command line will record the bot's logs.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonebeld%2Fsparklescannerbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonebeld%2Fsparklescannerbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonebeld%2Fsparklescannerbot/lists"}