{"id":15671498,"url":"https://github.com/rayz1065/checkbot","last_synced_at":"2025-08-11T23:05:18.776Z","repository":{"id":186818311,"uuid":"675812366","full_name":"rayz1065/checkbot","owner":"rayz1065","description":"A telegram bot and mini-app to manage private checklists","archived":false,"fork":false,"pushed_at":"2024-10-01T10:30:10.000Z","size":372,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-30T05:25:09.188Z","etag":null,"topics":["grammyjs","telegram","telegram-bot","telegram-web-app"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rayz1065.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-07T19:32:16.000Z","updated_at":"2025-01-29T16:27:26.000Z","dependencies_parsed_at":"2023-08-07T21:54:52.948Z","dependency_job_id":"a5bb03bc-bf45-4930-b71d-242d2a16918d","html_url":"https://github.com/rayz1065/checkbot","commit_stats":{"total_commits":44,"total_committers":1,"mean_commits":44.0,"dds":0.0,"last_synced_commit":"9db7fe35181d861a18e7b8b930986de230aad72e"},"previous_names":["rayz1065/checkbot"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rayz1065/checkbot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rayz1065%2Fcheckbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rayz1065%2Fcheckbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rayz1065%2Fcheckbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rayz1065%2Fcheckbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rayz1065","download_url":"https://codeload.github.com/rayz1065/checkbot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rayz1065%2Fcheckbot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269970120,"owners_count":24505466,"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","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["grammyjs","telegram","telegram-bot","telegram-web-app"],"created_at":"2024-10-03T15:02:56.813Z","updated_at":"2025-08-11T23:05:18.752Z","avatar_url":"https://github.com/rayz1065.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CheckBot, a private Telegram bot to manage checklists\n\nThis bot can manage checklists in:\n\n- groups, through the #check hashtag and /check command\n- channels, by editing on the fly posts with #check in them\n- the private chat with the bot, by responding to any message containing checkboxes\n- any chat using inline mode\n\nIt even works in groups with protected content OR (exclusive) anonymous admins in groups.\nIt does _not_ work for anonymous admins in groups with protected content.\n\n## How it works\n\nThe checklist is not stored in the database, instead, every time a checklist is edited, the bot forwards the message containing it to the user's chat in order to read it.\nBefore allowing the user to update a checklist a series of verification steps is performed, controlling the authenticity of the request through a hash stored in the URL and the permissions through the Telegram bot API.\n\nThere are a couple of workarounds to make all of the settings indicated above work, like using the private chat of the user to store a checklist in a group with protected content.\n\n## Infrastructure\n\nThe bot and web app are made to run inside [docker](https://www.docker.com/), both during development and deployment.\nThe `src` directory contains the code for the bot server:\n\n- The bot itself, written using the [GrammyJs](https://grammy.dev/) framework\n- The api, required by the webapp to interface with the bot's logic, written using the [ExpressJs](https://expressjs.com/) framework\n\nThe `web` directory contains the webapp, which can be used to more quickly edit checklists in any chat. It is built in [Remix](https://remix.run/), a web framework based on react.\nIt uses [Mantine](https://mantine.dev/) as the components library.\n\nThe database, which is used to store basic user data such as the configs, uses [postgres](https://www.postgresql.org/) and is managed through [prisma](https://www.prisma.io/).\n\nA suggested method for deployment is present in `docker-compose.prod.yml`, which shows how [traefik](https://traefik.io/) can be used as a reverse proxy for the various services.\n\n## Setup and run\n\nYou will need a bot API token, get one by contacting [BotFather](https://t.me/botfather), after that create a .env file by copying the .env.example, be sure to change the `CHECKBOX_HMAC_SECRET` with a random string, `POSTGRES_PASSWORD` with a secure password, and `BOT_TOKEN` with the token you received from BotFather.\nIn order to run the web app, you will need to set the `WEB_APP_URL` to the website where the web app is hosted, and `WEB_APP_API_URL` to the url where the express server with the api is hosted.\n\nCopy or link the configuration you want to use to `docker-compose.override.yml`.\nTo use the bot in development mode write:\n\n```sh\nln --symbolic --force docker-compose.dev.yml docker-compose.override.yml\n```\n\nYou may also want to run `yarn install` to download the dependencies on your machine, which are essential for your code editor to give you hints.\n\nTo use it in production mode write:\n\n```sh\nln --symbolic --force docker-compose.prod.yml docker-compose.override.yml\n```\n\nStart the services by running:\n\n```sh\ndocker compose up\n```\n\nYou will need to do a one-time setup of the bot, to get the exact list of steps run:\n\n```sh\ndocker compose exec app npx ts-node src/bin/setup-bot.ts\n```\n\nYou can use that utility script to update most configurations automatically for you, the rest will need to be changed through BotFather.\n\nFinally you will need to run the database migrations:\n\n```sh\ndocker compose exec app npx prisma migrate deploy\n```\n\n## Translating\n\nTranslating is done in the [fluent](https://projectfluent.org/) language, create or edit a file under `src/i18n`, the language will be immediately available to users who have set it in the Telegram client.\nIf you want to add it to the available configurations edit `src/modules/check-config.ts` and add it to `botLanguages`.\n\n## License\n\n[GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frayz1065%2Fcheckbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frayz1065%2Fcheckbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frayz1065%2Fcheckbot/lists"}