|
1 | | -# Evolution Manager |
| 1 | +# React + TypeScript + Vite |
2 | 2 |
|
3 | | -## Introduction |
| 3 | +This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. |
4 | 4 |
|
5 | | -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). |
| 5 | +Currently, two official plugins are available: |
6 | 6 |
|
7 | | ---- |
| 7 | +- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh |
| 8 | +- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh |
8 | 9 |
|
9 | | -🇧🇷 **Atenção, Comunidade Brasileira!** 🇧🇷 |
| 10 | +## Expanding the ESLint configuration |
10 | 11 |
|
11 | | -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: |
| 12 | +If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: |
12 | 13 |
|
13 | | -🔗 [Leia o README em Português](https://github.com/gabrielpastori1/evolution-manager/blob/main/README.pt_BR.md) |
| 14 | +- Configure the top-level `parserOptions` property like this: |
14 | 15 |
|
15 | | ---- |
16 | | - |
17 | | -## Features |
18 | | - |
19 | | -- **Instance Management**: Create, manage, and delete instances. |
20 | | -- **Instance Settings**: Customize behavior settings (e.g., disabling calls, always-online mode), webhook integration, RabbitMQ, WebSocket, Chatwoot, and Typebot configurations. |
21 | | -- **User Utilities**: Check user numbers, search for conversations, and find groups. |
22 | | - |
23 | | -## Limitations |
24 | | - |
25 | | -- The version hosted on Vercel requires the server to have an SSL certificate. |
26 | | - |
27 | | -## Technology |
28 | | - |
29 | | -- The project is built using Vue.js v3 and Vuetify. |
30 | | - |
31 | | -## Evolution-Manager CLI - Documentation |
32 | | - |
33 | | -For detailed information on how to use the Evolution-Manager CLI, please refer to the documentation available at the following links: |
34 | | - |
35 | | -🔗 Full Documentation: [Documentation in English](https://github.com/gabrielpastori1/evolution-manager/blob/main/docs/en/cli.md) |
36 | | - |
37 | | -## Docker Image - Documentation |
38 | | - |
39 | | -For detailed information on using the Docker image, including configurations and examples, please refer to our comprehensive documentation. You will find step-by-step instructions, as well as helpful tips to make the most of the Evolution Manager's Docker image. |
40 | | - |
41 | | -🔗 Full Documentation: [Documentation in English](https://github.com/gabrielpastori1/evolution-manager/tree/main/docs/en/docker.md) |
42 | | - |
43 | | -## Self-Hosted - Evolution Manager CLI and PM2 |
44 | | - |
45 | | -### Straight to the Point: Quick Setup with PM2 |
46 | | - |
47 | | -To quickly install Evolution Manager globally and set it up with PM2, follow these commands: |
48 | | - |
49 | | -1. **Install Evolution Manager Globally**: |
50 | | - |
51 | | - ```bash |
52 | | - npm install -g evolution-manager |
53 | | - ``` |
54 | | - |
55 | | -2. **Set Up PM2 for Evolution Manager**: |
56 | | - |
57 | | - ```bash |
58 | | - evolution-manager pm2 setup |
59 | | - ``` |
60 | | - |
61 | | -These two steps will install the Evolution Manager CLI globally on your system and configure it to run with PM2, a powerful process manager. |
62 | | - |
63 | | -### Installation and Configuration |
64 | | - |
65 | | -These two steps will install the Evolution Manager CLI globally on your system and configure it to run with PM2, a powerful process manager. |
66 | | - |
67 | | -1. **Install Evolution Manager Globally**: |
68 | | - - Ensure Node.js and NPM are installed on your system. |
69 | | - - Install Evolution Manager globally using NPM to access the CLI (Command Line Interface): |
70 | | - |
71 | | - ```bash |
72 | | - npm install -g evolution-manager |
73 | | - ``` |
74 | | - |
75 | | -2. **Using the CLI**: |
76 | | - - After installation, access the CLI commands by typing `evolution-manager` in your terminal. |
77 | | - - Available commands include: |
78 | | - - `help`: Displays a list of available commands and their descriptions. |
79 | | - - `server`: Server-related operations. |
80 | | - - `start [--port=9615]`: Starts the server on the specified port (default: 9615). |
81 | | - - `build`: Builds the project. |
82 | | - - `pm2`: Manages the process with PM2. |
83 | | - - `setup`: Sets up PM2 for the project. |
84 | | - - `start`: Starts the service with PM2. |
85 | | - - `stop`: Stops the service in PM2. |
86 | | - - `restart`: Restarts the service in PM2. |
87 | | - - `delete`: Removes the service from PM2. |
88 | | - |
89 | | -3. **Running the Project with PM2**: |
90 | | - - To set up and manage the service with PM2, start with the setup command: |
91 | | - |
92 | | - ```bash |
93 | | - evolution-manager pm2 setup |
94 | | - ``` |
95 | | - |
96 | | - - Then, you can start, stop, restart, or delete the service using the respective `pm2` commands in the CLI. |
97 | | - |
98 | | -These instructions provide a streamlined method for managing Evolution Manager across various systems, utilizing PM2 for efficient service start-up, maintenance, and control. |
99 | | - |
100 | | -## Development Setup |
101 | | - |
102 | | -1. **Prerequisites**: Ensure you have `yarn` installed on your system. |
103 | | -2. **Clone the Repository**: |
104 | | - |
105 | | - ```bash |
106 | | - git clone https://github.com/gabrielpastori1/evolution-manager.git |
107 | | - cd evolution-manager |
108 | | - ``` |
109 | | - |
110 | | -3. **Install Dependencies**: |
111 | | - |
112 | | - ```bash |
113 | | - yarn install |
114 | | - ``` |
115 | | - |
116 | | -4. **Run Development Server**: |
117 | | - |
118 | | - ```bash |
119 | | - yarn dev |
120 | | - ``` |
121 | | - |
122 | | - This will start a local development server. You can access the app at `localhost:8080`. |
123 | | - |
124 | | -## Building the Project |
125 | | - |
126 | | -To build the project for production, run: |
127 | | - |
128 | | -```bash |
129 | | -yarn build |
| 16 | +```js |
| 17 | +export default { |
| 18 | + // other rules... |
| 19 | + parserOptions: { |
| 20 | + ecmaVersion: 'latest', |
| 21 | + sourceType: 'module', |
| 22 | + project: ['./tsconfig.json', './tsconfig.node.json', './tsconfig.app.json'], |
| 23 | + tsconfigRootDir: __dirname, |
| 24 | + }, |
| 25 | +} |
130 | 26 | ``` |
131 | 27 |
|
132 | | -This will create a `dist` folder with the compiled assets. |
133 | | - |
134 | | -## Contributing |
135 | | - |
136 | | -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: |
137 | | -
|
138 | | -### Making a Donation |
139 | | -
|
140 | | -If you wish to support the project financially, we have provided a QR code for Pix donations. Your generosity helps in maintaining and evolving this open-source tool. |
141 | | -
|
142 | | -<img src="https://github.com/gabrielpastori1/evolution-manager/blob/main/src/assets/pix.svg" width="300" alt="Pix Donation QR Code"> |
143 | | -
|
144 | | -### Contributing Code or Ideas |
145 | | -
|
146 | | -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. |
147 | | - |
148 | | -Your support, in any form, makes a significant difference and is greatly appreciated. Thank you for being a part of the Evolution Manager community! |
149 | | - |
150 | | -## License |
151 | | - |
152 | | -This project is open-source and available under the [MIT License](LICENSE.md). |
| 28 | +- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked` |
| 29 | +- Optionally add `plugin:@typescript-eslint/stylistic-type-checked` |
| 30 | +- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list |
0 commit comments