45 lines
1.1 KiB
Markdown
45 lines
1.1 KiB
Markdown
# WhatsApp Web.js Server
|
|
|
|
Complete WhatsApp automation server with REST API, WebSocket, and SQLite storage.
|
|
|
|
## Features
|
|
|
|
✅ **REST API** - Send messages, retrieve contacts/chats/messages
|
|
✅ **WebSocket** - Real-time event streaming
|
|
✅ **SQLite** - Persistent storage for all data
|
|
✅ **Media Storage** - Automatic media file handling
|
|
✅ **Authentication** - API key protection
|
|
✅ **QR Code Web UI** - Easy WhatsApp authentication via browser
|
|
✅ **All Original Commands** - Full command handler support
|
|
|
|
## Quick Start
|
|
|
|
### Local Development
|
|
|
|
```bash
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
Visit `http://localhost:3001/qr` to scan the WhatsApp QR code.
|
|
|
|
### Docker Deployment
|
|
|
|
```bash
|
|
docker-compose up -d --build
|
|
```
|
|
|
|
Visit `http://your-server:3001/qr` to authenticate WhatsApp.
|
|
|
|
## QR Code Authentication - Web-UI
|
|
|
|
The server provides a web interface for easy WhatsApp authentication:
|
|
|
|
- **URL**: `http://localhost:3001/qr`
|
|
- **Features**:
|
|
- Real-time QR code display
|
|
- Live connection status updates
|
|
- Auto-refresh on new QR codes
|
|
- Mobile-friendly design
|
|
|
|
The QR code is also printed in the console logs for terminal access. |