Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zavierferodova/alisya-chatbot
Friendly conversational chatbot for WhatsApp
https://github.com/zavierferodova/alisya-chatbot
chatbot generative-ai llm whatsapp-bot
Last synced: about 1 month ago
JSON representation
Friendly conversational chatbot for WhatsApp
- Host: GitHub
- URL: https://github.com/zavierferodova/alisya-chatbot
- Owner: zavierferodova
- Created: 2024-07-23T16:01:39.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-28T08:10:33.000Z (4 months ago)
- Last Synced: 2024-10-01T07:41:31.486Z (about 1 month ago)
- Topics: chatbot, generative-ai, llm, whatsapp-bot
- Language: TypeScript
- Homepage:
- Size: 180 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Alisya Chatbot
A friendly conversational chatbot named Alisya integrated with Large Language Model (llama3-8b-8192) for creating response and using SQLite to store conversation as memory. Using [whatsapp-web.js](https://wwebjs.dev) as interface so this bot can used for everyone using their personal WhatsApp number.
### Feature List
1. Add number to group chat.
2. Kick person from group chat.
3. Make sticker from sent image media.
4. Tagging all group participants.
5. Sending a message or media via bot to someone.
6. Talking with bot using LLM.
7. Take over, automatic message response assistant.
### Setup
1. Install node modules,
```bash
npm install
```
2. Create `.env` file from `.env.example`,
```bash
cp .env.example .env
```
3. Fill `.env` file,
```
CHIPER_KEY=
GROQ_API_KEY=
DB_NAME=BotDatabase.db
```
4. Perform database migration to store chat conversation and seeding for initialize data,
```bash
npm run migrate
npm run seed
```
5. Start node application (Choose one),
```bash
# Production server
npm start
# Development server
npm run dev
6. Wait application to start and after QR Code appeared scan it on WhatsApp to login,
7. After client authenticated you're ready to go,
8. Enjoyy...
### Usage
You can send a `!help` command message to show the list action that bot can do. For bot configuration command you can send `!help` command message to your self WhatsApp phone number.
### Additional Note
This bot using LLM from [Groq AI](https://groq.com) you can grab your API key from that site and fill it into env file.
### Libraries
- [whatsapp-web.js](https://groq.com)
- [LangChain.js](https://js.langchain.com)
- [LangChain Groq](https://www.npmjs.com/package/@langchain/groq)
- [Sequelize](https://sequelize.org)
### Credits
Developed by Zavier Ferodova Al Fitroh ✌️