https://github.com/xmtp/botkit

botkit
https://github.com/xmtp/botkit

Last synced: about 2 months ago
JSON representation

botkit

• Host: GitHub
• URL: https://github.com/xmtp/botkit
• Owner: xmtp
• License: mit
• Created: 2024-04-25T11:40:45.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-05-03T13:29:15.000Z (2 months ago)
• Last Synced: 2024-05-03T16:16:44.288Z (2 months ago)
• Language: TypeScript
• Size: 2.56 MB
• Stars: 1
• Watchers: 8
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Lists

• awesome-xmtp - BotKit

README

        
# XMTP bot kit and examples

This is the official repository for the XMTP bot kit and examples, powered by [Turborepo](https://turbo.build/repo).

To learn more about the contents of this repository, see this README and the READMEs provided for [packages](https://github.com/xmtp/botkit/tree/main/packages) and [examples](https://github.com/xmtp/botkit/tree/main/examples).

## What's inside?

### Packages

- [`botkit`](https://github.com/xmtp/botkit/blob/main/packages/botkit): A kit for quickly building bots on the XMTP network

- [`create-xmtp-bot`](https://github.com/xmtp/botkit/blob/main/packages/create-xmtp-bot): A CLI for creating new XMTP bot projects

### Examples

- [`conversational`](https://github.com/xmtp/botkit/blob/main/examples/conversational): A simple, customizable, and powerful conversational framework

- [`gm`](https://github.com/xmtp/botkit/blob/main/examples/gm): A simple bot that responds `gm` to any incoming messages

- [`gpt`](https://github.com/xmtp/botkit/blob/main/examples/gpt): A bot that relays incoming messages to OpenAI's ChatGPT

See more examples in the [Awesome XMTP ⭐️](https://github.com/xmtp/awesome-xmtp) repo

#### Run the example bots locally

> **Note**  

> Before starting the bots locally, install the necessary dependencies by running `yarn` first.

- `yarn start:conversational`: Start the conversational bot

- `yarn start:gm`: Start the GM bot

- `yarn start:gpt`: Start the ChatGPT bot

## Contributing

See our [contribution guide](./CONTRIBUTING.md) to learn more about contributing to this project.