NeoAnd/evolution-manager
1
0
Fork 0
mirror of https://github.com/EvolutionAPI/evolution-manager.git synced 2025-07-13 15:14:49 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Gabriel Pastori 2023-11-12 23:08:40 -03:00 committed by GitHub
parent 266e859e53
commit 1ffe89ddff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 44 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
README.md
View File

@ -1,69 +1,57 @@
# essentials # Evolution Manager - README
## Project setup ## 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).
``` ## Features
# yarn - **Instance Management**: Create, manage, and delete instances.
yarn - **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.
# npm ## Limitations
npm install - The version hosted on Vercel requires the server to have an SSL certificate.
# pnpm ## Technology
pnpm install - The project is built using Vue.js v3 and Vuetify.
# bun ## Development Setup
bun install 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 serve
```
This will start a local development server. You can access the app at `localhost:8080`.
### Compiles and hot-reloads for development ## Building the Project
To build the project for production, run:
``` ```bash
# yarn
yarn dev
# npm
npm run dev
# pnpm
pnpm dev
# bun
bun run dev
```
### Compiles and minifies for production
```
# yarn
yarn build yarn build
# npm
npm run build
# pnpm
pnpm build
# bun
bun run build
``` ```
This will create a `dist` folder with the compiled assets.
### Lints and fixes files ## Self-Hosted Instructions (Ubuntu Server)
1. **Prepare the Environment**: Install Node.js, Yarn, and any other necessary dependencies on your Ubuntu server.
2. **Clone and Build**:
- Clone the repository and build the project using the steps provided in the Development Setup section.
3. **Deploy**:
- Host the contents of the `dist` folder on your web server.
- Ensure the server is configured with an SSL certificate for secure access.
``` ## Contributing
# yarn Contributions are welcome! Please read our contributing guidelines to get started.
yarn lint
# npm ## License
npm run lint This project is open-source and available under the [MIT License](LICENSE.md).
# pnpm ---
pnpm lint
# bun Note: Replace `[LICENSE.md]` with the actual link to the license file in the repository.
bun run lint
```
### Customize configuration
See [Configuration Reference](https://vitejs.dev/config/).