Some checks failed
Deploy / deploy (push) Has been cancelled
Full-stack web application for Telegram management - Frontend: Vue 3 + Vben Admin - Backend: NestJS - Features: User management, group broadcast, statistics 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
3.3 KiB
3.3 KiB
Quick Start Guide - Telegram Marketing Agent System
Prerequisites
- Docker and Docker Compose installed
- At least 8GB of RAM available
- Telegram API credentials (API ID and API Hash)
🚀 Quick Setup
1. Clone and Navigate
cd telegram-management-system/marketing-agent
2. Configure Environment
# Copy the development environment file
cp .env.development .env
# Edit the .env file and add your Telegram credentials:
# TELEGRAM_API_ID=your-api-id
# TELEGRAM_API_HASH=your-api-hash
3. Start All Services
# Make scripts executable
chmod +x scripts/*.sh
# Start all services
./scripts/start-services.sh
4. Verify System Health
./scripts/health-check.sh
5. Access the Application
- Frontend: http://localhost:3008
- API Gateway: http://localhost:3030
- API Documentation: http://localhost:3030/api-docs
📝 Default Credentials
- Username: admin@example.com
- Password: admin123
🔧 Service Ports
| Service | Port | Description |
|---|---|---|
| Frontend | 3008 | Vue.js web interface |
| API Gateway | 3030 | Unified API endpoint |
| Orchestrator | 3001 | Campaign management |
| Claude Agent | 3002 | AI integration |
| GramJS Adapter | 3003 | Telegram integration |
| Safety Guard | 3004 | Content moderation |
| Analytics | 3005 | Data analytics |
| Compliance | 3006 | Compliance management |
| A/B Testing | 3007 | Experiment management |
🛠 Common Commands
View Logs
# All services
docker-compose logs -f
# Specific service
docker-compose logs -f api-gateway
Restart Services
# All services
docker-compose restart
# Specific service
docker-compose restart orchestrator
Stop Services
docker-compose down
Clean Reset
# Stop services and remove volumes
docker-compose down -v
# Start fresh
./scripts/start-services.sh
🚨 Troubleshooting
Service Won't Start
- Check port conflicts:
lsof -i :PORT - View logs:
docker-compose logs SERVICE_NAME - Ensure Docker has enough resources
API Gateway Connection Issues
- Verify API Gateway is running:
curl http://localhost:3030/health - Check service discovery:
curl http://localhost:3030/health/services - Review proxy configuration in
services/api-gateway/src/routes/proxy.js
Frontend Can't Connect to API
- Check browser console for errors
- Verify API Gateway is accessible
- Clear browser cache and cookies
Telegram Connection Issues
- Ensure API credentials are correct in
.env - Check gramjs-adapter logs:
docker-compose logs gramjs-adapter - Delete session files and reconnect
📚 Next Steps
- Connect Telegram Account: Navigate to Settings > Accounts in the web interface
- Create First Campaign: Go to Campaigns > Create Campaign
- Configure AI Assistant: Set up Claude API key in Settings
- Import Contacts: Use the data import feature in Settings
🔐 Security Notes
- Change default credentials immediately
- Update JWT_SECRET in production
- Configure proper CORS origins
- Enable HTTPS for production deployment
- Regularly update dependencies
📞 Support
- Check logs first:
docker-compose logs -f - Review documentation in
/docsdirectory - Create issues in the project repository
Happy Marketing! 🚀