{"id":18347668,"url":"https://github.com/botpress/messaging","last_synced_at":"2025-04-09T13:03:10.629Z","repository":{"id":37013436,"uuid":"362182588","full_name":"botpress/messaging","owner":"botpress","description":"Botpress messaging server","archived":false,"fork":false,"pushed_at":"2025-03-13T16:04:29.000Z","size":13401,"stargazers_count":43,"open_issues_count":7,"forks_count":39,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-04-02T12:03:10.029Z","etag":null,"topics":["botpress","messaging-api"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/botpress.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-27T16:39:01.000Z","updated_at":"2025-03-13T15:59:23.000Z","dependencies_parsed_at":"2024-01-11T17:44:10.640Z","dependency_job_id":"6630121a-f00b-4a85-90f8-2c068aaf0a1b","html_url":"https://github.com/botpress/messaging","commit_stats":{"total_commits":750,"total_committers":17,"mean_commits":44.11764705882353,"dds":0.5666666666666667,"last_synced_commit":"1cdfceb9eb7cf33b9b2dea31bbeb334ffd31775a"},"previous_names":[],"tags_count":75,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botpress%2Fmessaging","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botpress%2Fmessaging/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botpress%2Fmessaging/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botpress%2Fmessaging/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/botpress","download_url":"https://codeload.github.com/botpress/messaging/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248045230,"owners_count":21038553,"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":["botpress","messaging-api"],"created_at":"2024-11-05T21:14:38.434Z","updated_at":"2025-04-09T13:03:10.608Z","avatar_url":"https://github.com/botpress.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botpress Messaging\n\n[![npm](https://img.shields.io/npm/v/@botpress/messaging-client?label=%40botpress%2Fmessaging-client)](https://www.npmjs.com/package/@botpress/messaging-client)\n[![npm](https://img.shields.io/npm/v/@botpress/messaging-socket?label=%40botpress%2Fmessaging-socket)](https://www.npmjs.com/package/@botpress/messaging-socket)\n\nThe botpress messaging server provides a standardized messaging api to communicate with the following channels :\n\n- Messenger\n- Slack\n- Teams\n- Telegram\n- Twilio\n- Smooch\n- Vonage\n\n## Getting started\n\n### Prerequisites\n\n1.  Yarn v1+ (https://yarnpkg.com/)\n2.  Docker (https://www.docker.com/) and docker-compose (https://docs.docker.com/compose/)\n3.  Install recommended VSCode extensions\n4.  Optionally install [tilt](https://tilt.dev)\n\n### Useful Commands\n\nThe simplest way to run the setup locally would be with `tilt`.\n\n```sh\n\u003e tilt up\n```\n\nThen open http://localhost:10350 to use the tilt UI. `Tilt` will start 4 processes:\n\n1. `messaging`: messaging server (port 3100)\n2. `inject-build`: inject script build that watches for changes\n3. `inject-serve`: serves the inject script built by the `inject-build` process (port 8080)\n4. `webchat`: serves a live version of the webchat that uses the `inject-serve` server (port 3543)\n\nNote: The messaging `client id` inside the file `packages/inject/example.html` needs to be provider manually for now.\n\nOtherwise, to start the messaging server, simply run\n\n```sh\n\u003e yarn dev\n```\n\n_To easily make API calls to the server, use the `misc/api.rest` file_\n\nTo create a binary of the Messaging server\n\n```sh\n\u003e yarn package\n```\n\nTo run tests\n\n```sh\n\u003e yarn test\n```\n\n_Note: to run a specific test suite, add a colon followed by the name of the suite name to the command above (e.g. To run integration tests: `yarn test:int`)_\n\nTo lint the codebase\n\n```sh\n\u003e yarn eslint\n```\n\nTo format the codebase\n\n```sh\n\u003e yarn prettier\n```\n\nTo reset the codebase to its initial state\n\n```sh\n\u003e yarn reset\n```\n\nFor all other commands, please refer to the `scripts` of the root `package.json`\n\n## Test Suites\n\nFor more information about the different test suites, go [here](./test/README.md).\n\n## Internal Documentation\n\nYou can read the internal documentation [here](./docs/readme.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbotpress%2Fmessaging","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbotpress%2Fmessaging","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbotpress%2Fmessaging/lists"}