From 50cfa3e03680b004a19ce384c0b09b10023d08eb Mon Sep 17 00:00:00 2001 From: Gabriel Pastori <58153955+gabrielpastori1@users.noreply.github.com> Date: Sun, 19 Nov 2023 01:23:35 -0300 Subject: [PATCH] add contribute info --- README.md | 41 ++++++++++++++++++--- README.pt_BR.md | 43 ++++++++++++++++++++-- src/assets/pix.svg | 23 ++++++++++++ src/components/modal/About.vue | 34 ++++++++++++------ src/components/modal/Contribute.vue | 55 +++++++++++++++++++++++++++++ src/layouts/default/AppFooter.vue | 31 ++++++++++++---- 6 files changed, 204 insertions(+), 23 deletions(-) create mode 100644 src/assets/pix.svg create mode 100644 src/components/modal/Contribute.vue diff --git a/README.md b/README.md index e6341a4..6ede44d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Evolution Manager - README ## 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). --- @@ -9,57 +10,72 @@ Evolution Manager is an open-source management tool for the Evolution API, desig 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) +🔗 [Leia o README em Português](https://github.com/gabrielpastori1/evolution-manager/blob/main/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. - **User Utilities**: Check user numbers, search for conversations, and find groups. ## Limitations + - The version hosted on Vercel requires the server to have an SSL certificate. ## Technology + - The project is built using Vue.js v3 and Vuetify. ## Development Setup + 1. **Prerequisites**: Ensure you have `yarn` installed on your system. 2. **Clone the Repository**: + ```bash git clone https://github.com/gabrielpastori1/evolution-manager.git cd evolution-manager ``` + 3. **Install Dependencies**: + ```bash yarn install ``` + 4. **Run Development Server**: + ```bash yarn dev ``` + This will start a local development server. You can access the app at `localhost:8080`. ## Building the Project + To build the project for production, run: + ```bash yarn build ``` + This will create a `dist` folder with the compiled assets. ## Self-Hosted - Evolution Manager CLI and PM2 + ### Straight to the Point: Quick Setup with PM2 To quickly install Evolution Manager globally and set it up with PM2, follow these commands: 1. **Install Evolution Manager Globally**: + ```bash npm install -g evolution-manager ``` 2. **Set Up PM2 for Evolution Manager**: + ```bash evolution-manager pm2 setup ``` @@ -70,10 +86,10 @@ These two steps will install the Evolution Manager CLI globally on your system a These two steps will install the Evolution Manager CLI globally on your system and configure it to run with PM2, a powerful process manager. - 1. **Install Evolution Manager Globally**: - Ensure Node.js and NPM are installed on your system. - Install Evolution Manager globally using NPM to access the CLI (Command Line Interface): + ```bash npm install -g evolution-manager ``` @@ -94,14 +110,31 @@ These two steps will install the Evolution Manager CLI globally on your system a 3. **Running the Project with PM2**: - To set up and manage the service with PM2, start with the setup command: + ```bash evolution-manager pm2 setup ``` + - Then, you can start, stop, restart, or delete the service using the respective `pm2` commands in the CLI. These instructions provide a streamlined method for managing Evolution Manager across various systems, utilizing PM2 for efficient service start-up, maintenance, and control. + ## Contributing -Contributions are welcome! Please read our contributing guidelines to get started. + +Contributions are an essential part of the Evolution Manager project. Whether you're contributing code, suggestions, or feedback, your input is invaluable. To facilitate contributions, we have included a direct means for donations: + +### Making a Donation + +If you wish to support the project financially, we have provided a QR code for Pix donations. Simply scan the QR code below with your Pix app to make a contribution. Your generosity helps in maintaining and evolving this open-source tool. + +![Pix Donation QR Code](https://github.com/gabrielpastori1/evolution-manager/blob/main/src/assets/pix.svg) + +### Contributing Code or Ideas + +We also welcome code contributions and innovative ideas. If you're interested in contributing in this way, please read our contributing guidelines for more information on how to get started. + +Your support, in any form, makes a significant difference and is greatly appreciated. Thank you for being a part of the Evolution Manager community! ## License + This project is open-source and available under the [MIT License](LICENSE.md). diff --git a/README.pt_BR.md b/README.pt_BR.md index 7275d8d..9ac777d 100644 --- a/README.pt_BR.md +++ b/README.pt_BR.md @@ -1,54 +1,71 @@ # 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 ``` @@ -59,10 +76,10 @@ Estes dois passos instalarão o CLI do Evolution Manager globalmente em seu sist 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 ``` @@ -83,9 +100,31 @@ Esses dois passos instalarão o CLI do Evolution Manager globalmente em seu sist 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 +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 + +## Contribuindo + +As contribuições são uma parte essencial do projeto Evolution Manager. Seja contribuindo com código, sugestões ou feedback, sua participação é inestimável. Para facilitar as contribuições, incluímos um meio direto para doações: + +### Fazendo uma Doação + +Se desejar apoiar o projeto financeiramente, disponibilizamos um QR code para doações via Pix. Basta escanear o QR code abaixo com seu aplicativo Pix para fazer uma contribuição. Sua generosidade ajuda na manutenção e evolução desta ferramenta de código aberto. + +![QR Code para Doação Pix](https://github.com/gabrielpastori1/evolution-manager/blob/main/src/assets/pix.svg) + +### Contribuindo com Código ou Ideias + +Também recebemos contribuições de código e ideias inovadoras. Se você tem interesse em contribuir dessa forma, por favor, leia nossas diretrizes de contribuição para mais informações sobre como começar. + +Seu apoio, de qualquer forma, faz uma grande diferença e é muito apreciado. Obrigado por fazer parte da comunidade Evolution Manager! + +## Licença + +Este projeto é de código aberto e está disponível sob a [Licença MIT](LICENSE.md). diff --git a/src/assets/pix.svg b/src/assets/pix.svg new file mode 100644 index 0000000..591a015 --- /dev/null +++ b/src/assets/pix.svg @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/components/modal/About.vue b/src/components/modal/About.vue index 00541e2..c860f2a 100644 --- a/src/components/modal/About.vue +++ b/src/components/modal/About.vue @@ -15,21 +15,26 @@ Evolution API + Evolution API , facilita a gestão de suas APIs com uma interface intuitiva. Ele foi criado por desenvolvedores independentes, focando em melhorar a experiência do usuário e a administração das funcionalidades da API.

- - - mdi-github - Repositório no GitHub - +
+ + mdi-github + Repositório no GitHub + + + mdi-hand-coin + Contribua com o projeto + +

Processamento de Dados

@@ -60,9 +65,12 @@ + diff --git a/src/components/modal/Contribute.vue b/src/components/modal/Contribute.vue new file mode 100644 index 0000000..869a6e0 --- /dev/null +++ b/src/components/modal/Contribute.vue @@ -0,0 +1,55 @@ + + + diff --git a/src/layouts/default/AppFooter.vue b/src/layouts/default/AppFooter.vue index 39751a7..aae06a1 100644 --- a/src/layouts/default/AppFooter.vue +++ b/src/layouts/default/AppFooter.vue @@ -1,11 +1,22 @@