Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juniorkrz/stickerbot
A WhatsApp bot for creating stickers and much more.
https://github.com/juniorkrz/stickerbot
baileys baileys-bot baileys-md bot nodejs sticker typescript whatsapp whatsapp-bot
Last synced: about 1 month ago
JSON representation
A WhatsApp bot for creating stickers and much more.
- Host: GitHub
- URL: https://github.com/juniorkrz/stickerbot
- Owner: juniorkrz
- License: mit
- Created: 2024-06-18T00:50:00.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-26T02:24:37.000Z (about 2 months ago)
- Last Synced: 2024-09-27T14:04:35.685Z (about 2 months ago)
- Topics: baileys, baileys-bot, baileys-md, bot, nodejs, sticker, typescript, whatsapp, whatsapp-bot
- Language: TypeScript
- Homepage: https://stickerbot.jrkrz.com
- Size: 28.2 MB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StickerBot 🤖
💻 Originalmente desenvolvido em Python, migrado para JavaScript e agora escrito em TypeScript. 🎉
StickerBot é um bot de figurinhas com uma vasta gama de comandos. Ele pode:
- Auxiliar na administração do seu grupo
- Divertir os membros
- Criar figurinhas incríveis
## 🤖 Showcase
- Veja o bot em funcionamento [aqui](https://api.whatsapp.com/send/?phone=5581973241677&text=!menu).
## 📝 Lista de Tarefas
- Confira as tarefas pendentes e o progresso do projeto [aqui](TODO.md).
## 🚀 Funcionalidades Principais
- **Administração de Grupo:** Comandos para gerenciar e moderar grupos.
- **Criação de Figurinhas:** Transforme imagens, vídeos e textos em figurinhas personalizadas.
- **Diversão:** Baixe músicas do YouTube diretamente pelo WhatsApp.
## 📦 Instalação
1. Clone este repositório:
```bash
git clone https://github.com/juniorkrz/stickerbot
```
2. Navegue até o diretório do projeto:
```bash
cd stickerbot
```
3. Instale as dependências:
```bash
npm install
```
4. Configure as variáveis de ambiente necessárias (veja [.env.example](.env.example) para referência).
## 🚀 Como Usar
Compilando o projeto:
```bash
npm run build
```
Rodar em produção:
```bash
npm start
```
Rodar em desenvolvimento:
```bash
npm run dev
```
Rodar em desenvolvimento com auto reload:
```bash
npm run debug
```
## 🐳 Via Docker
Build:
```bash
docker build -t juniorkrz/stickerbot .
```
Run:
```bash
docker run -d --name stickerbot -p 3000:3000 -v [/your/data/folder]:/data juniorkrz/stickerbot
```
### Como escanear o QR Code
Assim que o container estiver em execução, você precisará vincular seu telefone a ele. Para fazer isso, você tem algumas opções:
- `http://localhost:3000/qr` para ver uma pequena página com o QR Code para digitalizar.
- `docker logs -f stickerbot` para abrir o log. O QR será impresso lá. (Via Docker)
## 🤝 Contribuição
1. Faça um fork do projeto
2. Crie uma branch para sua feature (`git checkout -b feature/nova-feature`)
3. Faça commit das suas alterações (`git commit -m 'Adiciona nova feature'`)
4. Faça push para a branch (`git push origin feature/nova-feature`)
5. Abra um Pull Request
## 👨🏻💻 Autor
- [Antônio Roberto Júnior](https://github.com/juniorkrz)
## 💡 Inspirações
Este projeto foi inspirado pelo trabalho de [helv-io/wa-stickerbot](https://github.com/helv-io/wa-stickerbot).
## 📄 Licença
Este projeto está licenciado sob a Licença MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.
## ⚙ Tecnologias e Ferramentas
## 🌟 Agradecimentos
Obrigado a todos os contribuidores e usuários que tornam este projeto possível!
---
Feito com 💜 por [Juniorkrz](https://github.com/juniorkrz)