Skip to content

EvolutionAPI/evolution-manager-v2

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Evolution Manager v2

Evolution Manager Logo

Modern Web Interface for Evolution API Management

License React TypeScript Vite

🌐 Demo📖 Documentation💬 Community

📋 Table of Contents

🚀 About

Evolution Manager v2 is a modern, responsive web interface built with React and TypeScript for managing Evolution API instances. It provides a comprehensive dashboard for WhatsApp API management, chatbot integrations, and real-time monitoring.

Key Highlights

  • 🎨 Modern UI/UX - Built with Radix UI and Tailwind CSS
  • 🌍 Multi-language - Support for PT-BR, EN-US, ES-ES, FR-FR
  • 📱 Responsive Design - Works perfectly on desktop and mobile
  • Real-time Updates - WebSocket integration for live data
  • 🔧 Easy Configuration - Environment-based configuration
  • 🐳 Docker Ready - Containerized deployment

✨ Features

📊 Dashboard & Monitoring

  • Instance overview and status monitoring
  • Real-time connection status
  • Performance metrics and analytics
  • Multi-instance management

💬 Chat Management

  • WhatsApp chat interface
  • Message history and search
  • Media file handling
  • Contact management

🤖 Chatbot Integrations

  • OpenAI - GPT-powered conversations
  • Dify - AI workflow automation
  • Typebot - Visual flow builder
  • Chatwoot - Customer support platform
  • Flowise - Low-code AI apps
  • N8N - Workflow automation
  • Evolution Bot - Built-in chatbot

🔗 Event Integrations

  • Webhook - HTTP event delivery
  • WebSocket - Real-time events
  • RabbitMQ - Message queue integration
  • SQS - Amazon Simple Queue Service
  • Apache Kafka - Event streaming platform

⚙️ Configuration Management

  • Instance settings and behavior
  • Proxy configuration
  • Authentication management
  • Environment variables

🎨 User Experience

  • Dark/Light theme support
  • Multi-language interface
  • Responsive design
  • Keyboard shortcuts
  • Accessibility features

📸 Screenshots

Click to view screenshots

Dashboard

Dashboard

Chat Interface

Chat

Chatbot Configuration

Chatbot

Settings

Settings

🚀 Quick Start

Prerequisites

  • Node.js 18+ and npm
  • Evolution API instance running
  • Modern web browser

Installation

# Clone the repository
git clone https://github.com/EvolutionAPI/evolution-manager-v2.git
cd evolution-manager-v2

# Install dependencies
npm install

# Start development server
npm run dev

Open http://localhost:5173 in your browser.

📦 Installation

Method 1: NPM (Recommended)

# Install globally
npm install -g evolution-manager

# Or run directly
npx evolution-manager

Method 2: Docker

# Pull and run
docker run -p 3000:80 evolutionapi/evolution-manager:latest

# Or use docker-compose
docker-compose up -d

Method 3: Build from Source

# Clone repository
git clone https://github.com/EvolutionAPI/evolution-manager-v2.git
cd evolution-manager-v2

# Install dependencies
npm install

# Build for production
npm run build

# Serve built files
npm run preview

⚙️ Configuration

Environment Variables

Create a .env file in the root directory:

# Evolution API Configuration
VITE_EVOLUTION_API_URL=http://localhost:8080
VITE_EVOLUTION_API_KEY=your-api-key

# Application Configuration
VITE_APP_NAME="Evolution Manager"
VITE_APP_VERSION="2.0.0"

# Optional: Custom Branding
VITE_LOGO_URL="/assets/images/custom-logo.png"
VITE_FAVICON_URL="/assets/images/custom-favicon.ico"

# Optional: Analytics
VITE_GOOGLE_ANALYTICS_ID=GA_MEASUREMENT_ID

API Connection

The manager connects to your Evolution API instance. Configure the connection in the login screen or via environment variables.

Customization

  • Themes: Modify src/index.css for custom styling
  • Languages: Add translations in src/translate/languages/
  • Components: Extend UI components in src/components/ui/

🛠️ Development

Development Setup

# Install dependencies
npm install

# Start development server with hot reload
npm run dev

# Run linting
npm run lint

# Type checking
npm run type-check

Project Structure

src/
├── components/          # Reusable UI components
│   ├── ui/             # Base UI components (Radix + Tailwind)
│   └── providers/      # Context providers
├── pages/              # Application pages/routes
├── lib/                # Utilities and API clients
│   ├── queries/        # React Query hooks
│   └── utils.ts        # Helper functions
├── contexts/           # React contexts
├── translate/          # Internationalization
├── types/              # TypeScript type definitions
└── services/           # External service integrations

Tech Stack

  • Frontend: React 18, TypeScript, Vite
  • UI Library: Radix UI, Tailwind CSS
  • State Management: React Query, Context API
  • Routing: React Router DOM
  • Forms: React Hook Form + Zod
  • Icons: Lucide React
  • Charts: Recharts
  • Real-time: Socket.io Client

🐳 Docker

Using Docker Compose

version: '3.8'
services:
  evolution-manager:
    image: evolutionapi/evolution-manager:latest
    ports:
      - "3000:80"
    environment:
      - VITE_EVOLUTION_API_URL=http://evolution-api:8080
    depends_on:
      - evolution-api

Building Custom Image

# Build image
docker build -t my-evolution-manager .

# Run container
docker run -p 3000:80 my-evolution-manager

🔌 API Integration

Connecting to Evolution API

  1. Login Screen: Enter your Evolution API URL and credentials
  2. Environment: Set VITE_EVOLUTION_API_URL and VITE_EVOLUTION_API_KEY
  3. Runtime: Configure via the settings page

API Endpoints

The manager uses the following Evolution API endpoints:

  • GET /instance - List instances
  • POST /instance - Create instance
  • GET /instance/:name - Get instance details
  • POST /message/sendText - Send messages
  • GET /chat - List chats
  • And many more...

Authentication

Supports multiple authentication methods:

  • API Key authentication
  • JWT tokens
  • Instance-specific tokens

🌍 Internationalization

Supported Languages

  • 🇧🇷 Portuguese (Brazil) - pt-BR
  • 🇺🇸 English (US) - en-US
  • 🇪🇸 Spanish - es-ES
  • 🇫🇷 French - fr-FR

Adding New Languages

  1. Create translation file in src/translate/languages/
  2. Add language option in src/components/language-toggle.tsx
  3. Update src/translate/i18n.ts

Example translation file structure:

{
  "dashboard": {
    "title": "Dashboard",
    "instances": "Instances"
  },
  "chat": {
    "send": "Send",
    "message": "Message"
  }
}

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Development Process

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes
  4. Run tests: npm run test
  5. Commit changes: npm run commit
  6. Push to branch: git push origin feature/amazing-feature
  7. Open a Pull Request

Code Style

  • Use TypeScript for all new code
  • Follow the existing code style
  • Run npm run lint before committing
  • Write meaningful commit messages

Reporting Issues

Please use our Issue Templates when reporting bugs or requesting features.

📄 License

This project is licensed under the Apache License 2.0 with additional conditions - see the LICENSE file for details.

Commercial Usage

Evolution Manager can be used commercially, but please review the license conditions regarding:

  • Logo and copyright information
  • Usage notification requirements

For commercial licensing inquiries, contact: [email protected]

🆘 Support

Community Support

Professional Support

FAQ

How do I connect to my Evolution API instance?

Use the login screen to enter your API URL and credentials, or set the VITE_EVOLUTION_API_URL environment variable.

Can I customize the interface?

Yes! You can modify themes, add languages, and customize components. See the Configuration section.

Is this compatible with Evolution API v1?

Evolution Manager v2 is designed for Evolution API v2+. For v1 compatibility, use Evolution Manager v1.


Made with ❤️ by the Evolution API Team

⭐ Star us on GitHub🐛 Report Issues💬 Join Discord

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages