{"id":17482282,"url":"https://github.com/totigm/bot-builder","last_synced_at":"2025-04-22T14:09:50.952Z","repository":{"id":50890324,"uuid":"504076553","full_name":"totigm/bot-builder","owner":"totigm","description":"This is a library to create bots for different platforms. It handles all the commands stuff behind the scenes, so you can focus on your bot's logic.","archived":false,"fork":false,"pushed_at":"2024-03-11T09:34:52.000Z","size":108,"stargazers_count":7,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-22T14:09:42.548Z","etag":null,"topics":["abstraction","bot","bot-builder","botbuilder","builder","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/totigm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-16T08:36:22.000Z","updated_at":"2025-01-07T11:27:10.000Z","dependencies_parsed_at":"2024-03-11T10:53:38.950Z","dependency_job_id":null,"html_url":"https://github.com/totigm/bot-builder","commit_stats":{"total_commits":42,"total_committers":3,"mean_commits":14.0,"dds":0.0714285714285714,"last_synced_commit":"f96b57cbc0df3af44df8deb879e094bde2c6de38"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totigm%2Fbot-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totigm%2Fbot-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totigm%2Fbot-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totigm%2Fbot-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/totigm","download_url":"https://codeload.github.com/totigm/bot-builder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250255697,"owners_count":21400410,"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":["abstraction","bot","bot-builder","botbuilder","builder","typescript"],"created_at":"2024-10-18T23:05:20.839Z","updated_at":"2025-04-22T14:09:50.935Z","avatar_url":"https://github.com/totigm.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eWelcome to \u003cb\u003e@totigm/bot-builder\u003c/b\u003e 👋\u003c/h1\u003e\n\n\u003cp\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@totigm/bot-builder\" target=\"_blank\"\u003e\n    \u003cimg alt=\"NPM version\" src=\"https://img.shields.io/npm/v/@totigm/bot-builder\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/totigm/bot-builder\" target=\"_blank\"\u003e\n    \u003cimg alt=\"GitHub repo\" src=\"https://img.shields.io/badge/GitHub-@totigm/bot--builder-green?style=flat\u0026logo=github\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@totigm/bot-builder\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Downloads\" src=\"https://img.shields.io/npm/dt/@totigm/bot-builder\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/totigm/bot-builder/actions/workflows/main.yml\" target=\"_blank\"\u003e\n    \u003cimg alt=\"CI\" src=\"https://github.com/totigm/bot-builder/actions/workflows/main.yml/badge.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/totigm/bot-builder/stargazers\" target=\"_blank\"\u003e\n    \u003cimg alt=\"GitHub repo stars\" src=\"https://img.shields.io/github/stars/totigm/bot-builder?style=flat\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/totigm/bot-builder#readme\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Documentation\" src=\"https://img.shields.io/badge/documentation-yes-brightgreen\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/totigm/bot-builder/blob/main/LICENSE\" target=\"_blank\"\u003e\n    \u003cimg alt=\"License: MIT\" src=\"https://img.shields.io/github/license/totigm/bot-builder\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## 📄 Introduction\n\nThis is a library to create bots. It handles all the commands stuff behind the scenes, so you can focus on your bot's logic.\n\nThis library by itself is not a bot, but it provides an abstraction layer to create bots for different platforms. You just have to implement the `Bot` class, specifying a `client` and an `auth` method, and it will take care of the rest.\n\nThe `Bot` class uses generics types for the `Client` and `Message` types, so you can use it with any client for any platform that you want. They extend the `EventEmitter` and `BaseMessage` types respectively.\n\n## 🔗 Quick links\n\n- [Reference documentation](./docs/reference.md)\n- [Bot options](./docs/bot-options.md)\n- [WhatsApp bot](https://www.npmjs.com/package/@totigm/whatsapp-bot)\n- [Discord bot](https://www.npmjs.com/package/@totigm/discord-bot)\n- [GitHub](https://github.com/totigm/bot-builder#readme)\n- [NPM](https://www.npmjs.com/package/@totigm/bot-builder)\n\n## 💻 Installation\n\n```sh\nnpm i @totigm/bot-builder\n```\n\nor\n\n```sh\nyarn add @totigm/bot-builder\n```\n\n## 🚀 Getting started\n\nSee how to create a bot for [WhatsApp](https://www.npmjs.com/package/@totigm/whatsapp-bot) or [Discord](https://www.npmjs.com/package/@totigm/discord-bot). You can also create your own bot for any platform you want.\n\nStart adding commands to your bot by checking the [reference documentation](./docs/reference.md).\n\n## 🤖 Example usage\n\nCheck out [@totigm/whatsapp-bot](https://github.com/totigm/whatsapp-bot/blob/main/src/bot/index.ts) and [@totigm/discord-bot](https://github.com/totigm/discord-bot/blob/main/src/bot/index.ts) to see implementations for different platforms.\n\n## ⚙️ Options\n\nWhen you create a bot, you can pass an options object to customize it. Check the [bot options](./docs/bot-options.md) documentation for more information.\n\n```ts\nconst botOptions = { ... };\n\nconst bot = new Bot(botOptions);\n```\n\n## 👤 Author\n\n\u003ca href=\"https://github.com/totigm\" target=\"_blank\"\u003e\n  \u003cimg alt=\"GitHub: totigm\" src=\"https://img.shields.io/github/followers/totigm?label=Follow @totigm\u0026style=social\"\u003e\n\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://twitter.com/totigm8\" target=\"_blank\"\u003e\n  \u003cimg alt=\"Twitter: totigm8\" src=\"https://img.shields.io/twitter/follow/totigm8?style=social\" /\u003e\n\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://linkedin.com/in/totigm\" target=\"_blank\"\u003e\n  \u003cimg alt=\"LinkedIn: totigm\" src=\"https://img.shields.io/badge/LinkedIn-%40totigm-green?style=social\u0026logo=linkedin\" /\u003e\n\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://www.npmjs.com/~totigm\" target=\"_blank\"\u003e\n  \u003cimg alt=\"NPM: totigm\" src=\"https://img.shields.io/badge/NPM-%40totigm-green?style=social\u0026logo=npm\" /\u003e\n\u003c/a\u003e\n\n## 🤝 Contributing\n\nContributions are more than welcome!\n\nWe think that you might have great ideas to make this project even better. If you do, please create a pull request and/or issue following the [contribution guidelines](./docs/CONTRIBUTING.md).\n\n## ⭐️ Show your support\n\nGive a ⭐️ if this project helped you!\n\n## 📝 License\n\nCopyright © 2022 [Toti Muñoz](https://github.com/totigm).\u003cbr /\u003e\nThis project is [MIT](https://github.com/totigm/bot-builder/blob/master/LICENSE) licensed.\n\n---\n\nThis project was made with ❤ and TypeScript\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftotigm%2Fbot-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftotigm%2Fbot-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftotigm%2Fbot-builder/lists"}