https://github.com/jellydn/demo-chat-bot
Develop chatbots with zero configuration using typescript
https://github.com/jellydn/demo-chat-bot
chatbot react telegram typescript
Last synced: 6 months ago
JSON representation
Develop chatbots with zero configuration using typescript
- Host: GitHub
- URL: https://github.com/jellydn/demo-chat-bot
- Owner: jellydn
- License: mit
- Created: 2021-02-13T15:23:20.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T04:24:17.000Z (6 months ago)
- Last Synced: 2025-04-14T05:30:58.346Z (6 months ago)
- Topics: chatbot, react, telegram, typescript
- Language: TypeScript
- Homepage:
- Size: 2.05 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Welcome to demo-chat-bot 👋
> Start write chatbots with urban-bot and typescript
[![#Build with IT Man - ChatBot & AI - Part 1 [Vietnamese]](https://i.ytimg.com/vi/q1ngSbMqXUE/hqdefault.jpg)](https://www.youtube.com/watch?v=q1ngSbMqXUE)
## Prerequisites
- node >=16.20.0
## Install
```sh
yarn install
```
## Usage
Create .env from .env.example then run below command
```sh
yarn dev
```
## Run tests
```sh
yarn test
```
## How to setup
### Telegram
1. Get telegram [token](https://core.telegram.org/bots#6-botfather)
2. Paste token to `.env` `TELEGRAM_TOKEN=YOUR_TOKEN`
3. Uncomment `// import './render/telegram';` inside `src/index.ts`
4. Run `npm run dev` and check your bot
### Slack
1. Create [slack app](https://slack.com/intl/en-ru/help/articles/115005265703-Create-a-bot-for-your-workspace)
2. Paste [token](https://api.slack.com/authentication/token-types#granular_bot) to `.env` `SLACK_TOKEN=YOUR_TOKEN`
3. Paste [signing secret](https://api.slack.com/authentication/verifying-requests-from-slack#about) to `.env` `SLACK_SIGNING_SECRET=YOUR_SIGNING_SECRET`
4. Run `npm run start-tunnel` and connect the public url with slack webhook.
5. Uncomment `// import './render/slack';` inside `src/index.ts`
6. Run `npm run dev` and check your bot
### Facebook
1. Create [facebook app](https://developers.facebook.com/docs/messenger-platform/getting-started/app-setup)
2. Paste credentials to `.env`
3. Run `npm run start-tunnel` and connect the public url with facebook webhook.
4. Uncomment `// import './render/facebook';` inside `src/index.ts`
5. Run `npm run dev` and check your bot
## Author
- Website: https://productsway.com/
- Github: [@jellydn](https://github.com/jellydn)
## Resources
- [Urban Bot · The universal chatbot library based on React.](https://urban-bot.vercel.app/)
- [egoist/tsup: The simplest and fastest way to bundle your TypeScript libraries.](https://github.com/egoist/tsup)
- [jellydn/chatbot-starter-app: Develop chatbot with zero configuration using typescript](https://github.com/jellydn/chatbot-starter-app)
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
This project is [MIT](https://github.com/jellydn/demo-chat-bot/blob/master/LICENSE) licensed.