mirror of
https://github.com/EvolutionAPI/evolution-api.git
synced 2025-12-09 09:59:40 -06:00
6188944100
- Added new contributors to the README.md file - Updated the Comunidade Hub Connect link with a new one - Added four new content creators to the README.md file - The changes will improve the visibility of the project and its contributors - The updated file is README.md
180 lines
6.6 KiB
Markdown
180 lines
6.6 KiB
Markdown
<h1 align="center">Evolution Api</h1>
|
|
|
|
<div align="center">
|
|
|
|
[](https://evolution-api.com/whatsapp)
|
|
[](https://evolution-api.com/discord)
|
|
[](https://evolution-api.com/postman)
|
|
[](https://doc.evolution-api.com)
|
|
[](./LICENSE)
|
|
[](https://app.picpay.com/user/davidsongomes1998)
|
|
[](https://bmc.link/evolutionapi)
|
|
|
|
</div>
|
|
|
|
<div align="center"><img src="./public/images/cover.png"></div>
|
|
|
|
## Evolution API - Whatsapp API Node JS
|
|
|
|
This project is based on the [CodeChat](https://github.com/code-chat-br/whatsapp-api). The original project is an implementation of [Baileys](https://github.com/WhiskeySockets/Baileys), serving as a Restful API service that controls WhatsApp functions.</br>
|
|
The code allows the creation of multiservice chats, service bots, or any other system that utilizes WhatsApp. The documentation provides instructions on how to set up and use the project, as well as additional information about its features and configuration options.
|
|
|
|
The Evolution API has direct integration with [Typebot](https://github.com/baptisteArno/typebot.io) and [Chatwoot](https://github.com/chatwoot/chatwoot)
|
|
|
|
## Telemetry Notice
|
|
|
|
To continuously improve our services, we have implemented telemetry that collects data on the routes used, the most accessed routes, and the version of the API in use. We would like to assure you that no sensitive or personal data is collected during this process. The telemetry helps us identify improvements and provide a better experience for users.
|
|
|
|
## Evolution Pro Community
|
|
|
|
Join our Evolution Pro community for expert support and a weekly call to answer questions. Visit the link below to learn more and subscribe:
|
|
|
|
[Click here to learn more](https://pay.kiwify.com.br/SzPrarM)
|
|
<br>
|
|
<a href="https://pay.kiwify.com.br/SzPrarM">
|
|
<img src="./public/images/evolution-pro.png" alt="Subscribe" width="600">
|
|
</a>
|
|
|
|
# Instalation
|
|
|
|
### Installing NVM (Node Version Manager)
|
|
|
|
NVM allows you to install and manage multiple versions of Node.js. This is particularly useful for maintaining compatibility across different projects.
|
|
|
|
```sh
|
|
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
|
|
|
|
source ~/.bashrc
|
|
|
|
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
|
|
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
|
|
```
|
|
|
|
### Installing Node.js
|
|
|
|
```sh
|
|
nvm install v20.10.0 && nvm use v20.10.0
|
|
```
|
|
|
|
### Initializing the Application
|
|
|
|
Clone the repository:
|
|
|
|
```sh
|
|
git clone https://github.com/EvolutionAPI/evolution-api.git
|
|
```
|
|
Configure the environment variables in the [.env](./.env.example) file.
|
|
|
|
### Installing Application Dependencies
|
|
|
|
```sh
|
|
cd evolution-api
|
|
|
|
npm install
|
|
|
|
npm run build
|
|
```
|
|
|
|
### Env
|
|
> OBS: Rename the [.env.example](./.env.example) file to **.env**
|
|
```sh
|
|
cp .env.example .env
|
|
```
|
|
### Database Setup
|
|
|
|
The application supports PostgreSQL, MySQL, MariaDB.
|
|
|
|
Run one of the commands below for the non-existence of a database.
|
|
|
|
- **MySQL or MariaDB**:
|
|
|
|
```sh
|
|
npm run db:migrate:mysql
|
|
```
|
|
|
|
- **PostgreSQL**:
|
|
```sh
|
|
npm run db:migrate:postgres
|
|
```
|
|
|
|
#### Deploying
|
|
|
|
> For production environments.
|
|
|
|
For existing relational databases such as PostgreSQL, MySQL, or MariaDB, the setup involves two essential steps:
|
|
|
|
1. **Setting the Environment Variable**: Initially, it's imperative to define the `DATABASE_PROVIDER` environment variable in alignment with your relational database type. Use `postgresql` for PostgreSQL, and `mysql` for MySQL or MariaDB. This configuration is crucial as it directs the Prisma ORM regarding the specific relational database in use.
|
|
|
|
2. **Deploying Schema Changes**: Following this, execute the `npm run db:migrate:postgres` command. This command serves as a shortcut for the `prisma deploy` command, whose main role is to examine the current schema of the relational database and implement necessary modifications. A key feature of this command is its ability to update the database schema without affecting the existing data. This ensures that your current data remains intact while the database schema is updated to meet the latest requirements of the application.
|
|
|
|
#### Prisma Studio
|
|
|
|
- **View your data**
|
|
```sh
|
|
npm run db:studio:mysql
|
|
# or
|
|
npm run db:studio:postgres
|
|
```
|
|
|
|
This will sync your data models to your database, creating tables as needed.
|
|
|
|
### Running the Application
|
|
|
|
- **Development Mode**:
|
|
|
|
```sh
|
|
npm run dev:server
|
|
```
|
|
|
|
- **Production Mode**:
|
|
|
|
```sh
|
|
npm run build
|
|
npm run start:prod
|
|
```
|
|
|
|
# Note
|
|
|
|
This code is in no way affiliated with WhatsApp. Use at your own discretion. Don't spam this.
|
|
|
|
This code was produced based on the baileys library and it is still under development.
|
|
|
|
# Donate to the project.
|
|
|
|
#### PicPay
|
|
|
|
<div align="center">
|
|
<a href="https://app.picpay.com/user/davidsongomes1998" target="_blank" rel="noopener noreferrer">
|
|
<img src="./public/images/picpay-qr.jpeg" style="width: 50% !important;">
|
|
</a>
|
|
</div>
|
|
|
|
#### Buy me coffe - PIX
|
|
|
|
<div align="center">
|
|
<a href="https://bmc.link/evolutionapi" target="_blank" rel="noopener noreferrer">
|
|
<img src="./public/images/qrcode-pix.png" style="width: 50% !important;">
|
|
</a>
|
|
<p><b>CHAVE PIX (Telefone):</b> (74)99987-9409</p>
|
|
</div>
|
|
|
|
</br>
|
|
|
|
# Content Creator Partners
|
|
|
|
We are proud to collaborate with the following content creators who have contributed valuable insights and tutorials about Evolution API:
|
|
|
|
- [Promovaweb](https://www.youtube.com/@promovaweb)
|
|
- [Comunidade ZDG](https://www.youtube.com/@ComunidadeZDG)
|
|
- [Francis MNO](https://www.youtube.com/@FrancisMNO)
|
|
- [Pablo Cabral](https://youtube.com/@pablocabral)
|
|
- [XPop Digital](https://www.youtube.com/@xpopdigital)
|
|
- [Costar Wagner Dev](https://www.youtube.com/@costarwagnerdev)
|
|
- [Dante Testa](https://youtube.com/@dantetesta_)
|
|
- [Rubén Salazar](https://youtube.com/channel/UCnYGZIE2riiLqaN9sI6riig)
|
|
- [OrionDesign](youtube.com/OrionDesign_Oficial)
|
|
- [IMPA 365](youtube.com/@impa365_ofc)
|
|
- [Comunidade Hub Connect](https://youtube.com/@comunidadehubconnect)
|
|
- [dSantana Automações](https://www.youtube.com/channel/UCG7DjUmAxtYyURlOGAIryNQ?view_as=subscriber)
|
|
- [Edison Martins](https://www.youtube.com/@edisonmartinsmkt)
|
|
- [Astra Online](https://www.youtube.com/@astraonlineweb) |