diff --git a/README.md b/README.md index 59e1d91..e6341a4 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,17 @@ ## Introduction Evolution Manager is an open-source management tool for the Evolution API, designed to streamline the administration and monitoring of instances. It can be accessed online at [Evolution Manager](https://github.com/gabrielpastori1/evolution-manager). +--- + +🇧🇷 **Atenção, Comunidade Brasileira!** 🇧🇷 + +Se você é um desenvolvedor ou usuário brasileiro interessado no Evolution Manager, temos boas notícias! Agora você pode acessar a documentação completa do projeto em português. Isso facilitará seu entendimento e uso desta ferramenta incrível. Clique no link abaixo para ler o README em português: + +🔗 [Leia o README em Português](README.pt_BR.md) + +--- + + ## Features - **Instance Management**: Create, manage, and delete instances. - **Instance Settings**: Customize behavior settings (e.g., disabling calls, always-online mode), webhook integration, RabbitMQ, WebSocket, Chatwoot, and Typebot configurations. diff --git a/README.pt_BR.md b/README.pt_BR.md new file mode 100644 index 0000000..7275d8d --- /dev/null +++ b/README.pt_BR.md @@ -0,0 +1,91 @@ +# Evolution Manager - README + +## Introdução +O Evolution Manager é uma ferramenta de gerenciamento open-source para a Evolution API, projetada para facilitar a administração e monitoramento de instâncias. Pode ser acessada online em [Evolution Manager](https://github.com/gabrielpastori1/evolution-manager). + +## Funcionalidades +- **Gerenciamento de Instâncias**: Criação, gerenciamento e exclusão de instâncias. +- **Configurações de Instância**: Personalização das configurações de comportamento (por exemplo, desativar chamadas, modo sempre online), integração com webhook, RabbitMQ, WebSocket, Chatwoot e configurações do Typebot. +- **Utilitários para Usuários**: Verificação de números de usuários, busca por conversas e grupos. + +## Limitações +- A versão hospedada na Vercel requer que o servidor tenha um certificado SSL. + +## Tecnologia +- O projeto é desenvolvido usando Vue.js v3 e Vuetify. + +## Configuração para Desenvolvimento +1. **Pré-requisitos**: Certifique-se de ter o `yarn` instalado no seu sistema. +2. **Clonar o Repositório**: + ```bash + git clone https://github.com/gabrielpastori1/evolution-manager.git + cd evolution-manager + ``` +3. **Instalar Dependências**: + ```bash + yarn install + ``` +4. **Executar o Servidor de Desenvolvimento**: + ```bash + yarn dev + ``` + Isso iniciará um servidor de desenvolvimento local. Você pode acessar o aplicativo em `localhost:8080`. + +## Construção do Projeto +Para construir o projeto para produção, execute: +```bash +yarn build +``` +Isso criará uma pasta `dist` com os ativos compilados. + +## Auto-Hospedagem - CLI e PM2 do Evolution Manager +### Direto ao Ponto: Configuração Rápida com PM2 + +Para instalar rapidamente o Evolution Manager globalmente e configurá-lo com o PM2, siga estes comandos: + +1. **Instalar o Evolution Manager Globalmente**: + ```bash + npm install -g evolution-manager + ``` + +2. **Configurar PM2 para o Evolution Manager**: + ```bash + evolution-manager pm2 setup + ``` + +Estes dois passos instalarão o CLI do Evolution Manager globalmente em seu sistema e o configurarão para funcionar com o PM2, um gerenciador de processos poderoso. + +### Instalação e Configuração + +Esses dois passos instalarão o CLI do Evolution Manager globalmente em seu sistema e o configurarão para funcionar com o PM2, um gerenciador de processos poderoso. + + +1. **Instalar o Evolution Manager Globalmente**: + - Certifique-se de ter o Node.js e o NPM instalados em seu sistema. + - Instale o Evolution Manager globalmente usando o NPM para acessar o CLI (Interface de Linha de Comando): + ```bash + npm install -g evolution-manager + ``` + +2. **Usando o CLI**: + - Após a instalação, acesse os comandos do CLI digitando `evolution-manager` em seu terminal. + - Os comandos disponíveis incluem: + - `help`: Exibe uma lista de comandos disponíveis e suas descrições. + - `server`: Operações relacionadas ao servidor. + - `start [--port=9615]`: Inicia o servidor na porta especificada (padrão: 9615). + - `build`: Constrói o projeto. + - `pm2`: Gerencia o processo com o PM2. + - `setup`: Configura o PM2 para o projeto. + - `start`: Inicia o serviço com o PM2. + - `stop`: Para o serviço no PM2. + - `restart`: Reinicia o serviço no PM2. + - `delete`: Remove o serviço do PM2. + +3. **Executando o Projeto com o PM2**: + - Para configurar e gerenciar o serviço com o PM2, comece com o comando de configuração: + ```bash + evolution-manager pm2 setup + ``` + - Em seguida, você pode iniciar, parar, reiniciar ou excluir o serviço usando os respectivos comandos `pm2` no CLI. + +Estas instruções fornecem um método simplificado para gerenciar o Evolution Manager em vários sistemas, utilizando o PM2 para um eficiente início de serviço \ No newline at end of file diff --git a/package.json b/package.json index d80e087..b806cb3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "evolution-manager", - "version": "0.2.8", + "version": "0.2.9", "main": "dist", "scripts": { "dev": "vite", diff --git a/src/components/modal/Settings.vue b/src/components/modal/Settings.vue index b1071a9..7db6a7d 100644 --- a/src/components/modal/Settings.vue +++ b/src/components/modal/Settings.vue @@ -34,6 +34,14 @@ Sobre esse Manager + + mdi-logout +