{"id":13683745,"url":"https://github.com/chrispanag/ebony","last_synced_at":"2025-04-30T13:31:58.148Z","repository":{"id":32602418,"uuid":"137596845","full_name":"chrispanag/ebony","owner":"chrispanag","description":"🤖 💬 A module-based, multi-channel chatbot framework (aka ebenos)","archived":false,"fork":false,"pushed_at":"2023-03-04T09:31:05.000Z","size":2403,"stargazers_count":54,"open_issues_count":11,"forks_count":6,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-29T22:53:56.598Z","etag":null,"topics":["bot","chatbot","ebenos"],"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/chrispanag.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-06-16T17:04:05.000Z","updated_at":"2024-10-27T18:33:20.000Z","dependencies_parsed_at":"2023-02-18T03:40:24.685Z","dependency_job_id":"991c87da-b6c0-41da-99ca-aa3ca3fe0743","html_url":"https://github.com/chrispanag/ebony","commit_stats":{"total_commits":559,"total_committers":3,"mean_commits":"186.33333333333334","dds":"0.051878354203935606","last_synced_commit":"c302c5a7dc969c3bbf966df7f00152e54aa1f542"},"previous_names":[],"tags_count":68,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrispanag%2Febony","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrispanag%2Febony/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrispanag%2Febony/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrispanag%2Febony/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrispanag","download_url":"https://codeload.github.com/chrispanag/ebony/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224212489,"owners_count":17274406,"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":["bot","chatbot","ebenos"],"created_at":"2024-08-02T13:02:28.431Z","updated_at":"2024-11-12T03:31:47.157Z","avatar_url":"https://github.com/chrispanag.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Ebony Framework\n\n[![npm](https://img.shields.io/npm/v/@ebenos/framework)](https://www.npmjs.com/package/@ebenos/framework)\n![Node CI](https://github.com/chrispanag/ebony/workflows/Node%20CI/badge.svg)\n\nAn easy to use, module-based, multi-channel chatbot framework.\n\n## Features\n\n-   Separation in independent, portable, easy to customize [modules](docs/modules.md)\n-   Separate adapters for interfacing with communication channels (For now Facebook Messenger and Viber)\n-   Route-based rules, with middlewares\n\n## Getting Started\n\nFor now, there is no detailed documentation for Ebony Framework. You can easily create an ebony-based Facebook Messenger Bot with the [Messenger Bot Template](https://github.com/chrispanag/messenger-bot-template). If you have any questions and/or suggestions feel free to open an issue, or create a pull request.\n\n### Install Ebony Framework\n\n```\n$ yarn add @ebenos/framework\n```\n\n### Install an adapter\n\nFor Messenger:\n\n```\n$ yarn add @ebenos/messenger-adapter\n```\n\nFor Viber:\n\n```\n$ yarn add @ebenos/viber-adapter\n```\n\n### Initialize the bot\n\n```typescript\nimport { Bot } from '@ebenos/framework';\n\n// Import the adapter (for example the Messenger Adapter) as well as the user model\nimport { MessengerAdapter, MessengerUser } from '@ebenos/messenger-adapter';\n\n// ... Here import the modules you'll use...\nimport botModule from './modules/botModule';\n\n// Here you initialize the adapter.\n// For example the Messenger Adapter:\nconst adapter =\n    new MessengerAdapter({\n        pageId: /* Your FB Page ID */,\n        pageToken: /* Your Page Token */ ,\n        appSecret: /* Your App Secret */,\n        webhookKey: /* Your Webhook Key */\n    });\n\nexport const bot = new Bot\u003cMessengerUser\u003e(adapter, {\n    mongodbUri: /* Your MongoDB Connection URI */\n});\n\nbot.addModule(botModule);\n\nbot.start({\n    port: 3000 // You can substitute \"3000\" with the PORT of your choice.\n});\n```\n\n### Channel Adapters\n\nFor now, only a [Messenger Platform](https://developers.facebook.com/docs/messenger-platform) adapter is publicly available. If you want to use the Ebony Framework for another channel, open an issue to discuss the development of a new adapter.\n\n### Modules\n\nA module is a portable collection of actions, rules and middlewares that is imported into the chatbot on runtime.\n\nSee [Modules.md](docs/modules.md) for more information.\n\n#### Action\n\nAn action is a function that when it's triggered, it sends a message to the user.\n\n#### Rules\n\nThere are multiple types of rules inside a module. A rule could be context based (ContextRouter), postback based (PostbackRouter) or even a regex (TextMatcher). These rules, work similarly to routes in a web framework. They point to an action that is triggered when the rule is satisfied.\n\n#### Middlewares\n\nMiddlewares run before (preMiddlewares) and after (postMiddlewares) an action is triggered.\n\n## Development/Contributing\n\nHow to set up the ebony repository:\n\n1. `yarn install`\n2. `yarn lerna bootstrap`\n3. `yarn lerna run build`\n\n### Linting\n\n`yarn lerna run lint`\n\n## Next Steps\n\n-   Add tests\n-   Decouple database logic from framework (add support for multiple databases)\n-   Use redis for user context storing\n-   Create Slack adapter\n\n## Authors\n\n-   [Christos Panagiotakopoulos](https://github.com/chrispanag) - Initial Work \u0026 Project Leader\n-   [Dimitrios Gkegkas](https://github.com/DimitriosGkegkas) - Maintainer \u0026 Contributor\n-   [George Rouvalis](https://github.com/GeoRouv) - Initial Work on Viber integration\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrispanag%2Febony","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrispanag%2Febony","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrispanag%2Febony/lists"}