Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cinderjk/zete
Simple Panel for Baileys API
https://github.com/cinderjk/zete
api api-gateway whatsapp whatsapp-api whatsapp-gateway whatsapp-web
Last synced: about 2 months ago
JSON representation
Simple Panel for Baileys API
- Host: GitHub
- URL: https://github.com/cinderjk/zete
- Owner: cinderjk
- Archived: true
- Created: 2022-11-25T22:27:37.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T08:34:43.000Z (over 1 year ago)
- Last Synced: 2024-07-05T15:28:06.045Z (3 months ago)
- Topics: api, api-gateway, whatsapp, whatsapp-api, whatsapp-gateway, whatsapp-web
- Language: PHP
- Homepage:
- Size: 630 KB
- Stars: 48
- Watchers: 2
- Forks: 23
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Zete-Panel for WhatsApp API
[](https://github.com/cinderjk/zete/actions/workflows/laravel.yml)
Zete-Panel, is an open-source application interface for this
[ookamiiixd/baileys-api](https://github.com/ookamiiixd/baileys-api/tree/1.0.0-beta.0) with laravel/livewire and you can install it on any Shared Hosting that support NodeJs and SSH
## Features
- Auto-refreh QR Code
- Connect/Disconnect Device
- Message Log
- Send test Message
- Change Profile (Name)
- Regenerate API Key
- Built-in API with Documentation
- Use sanctum for API Token
- Ready-to-use
## Installation on Shared Hosting
### First you need to Setup the API.
1. Create a new subdomain, e.g. example.yourdomain.com
2. Open the terminal or SHH to start cloning this repository to your subdomain directory
```bash
git clone https://github.com/ookamiiixd/baileys-api.git public_html/example.yourdomain.com
```
3. Enter to the subdomain directory.
```bash
cd public_html/example.yourdomain.com
```
4. Setup configuration
#### Create a database for ookamiiiixd/baileys-api as it is needed for data storage
Then copy the .env from .env.example
```bash
cp .env.example .env
```
then edit the .env file, you can use nano with the command
```bash
nano .env
```
Paste this
```env
# Listening Host
HOST="127.0.0.1"
# Listening Port
PORT="48000"
# Database Connection URL
# mysql://{db_username}:{db_password}@127.0.0.1:3306/{db_name}
DATABASE_URL="mysql://root:[email protected]:3306/baileys_api"
# Reconnect Interval (in Milliseconds)
RECONNECT_INTERVAL="5000"
# Maximum Reconnect Attempts
MAX_RECONNECT_RETRIES="5"
# Maximum SSE QR Generation Attempts
SSE_MAX_QR_GENERATION="10"
# Pino Logger Level
LOG_LEVEL="warn"
```
5. Create .htaccess file, and copy these
```bash
Options +FollowSymLinks -Indexes
IndexIgnore *
DirectoryIndex
RewriteEngine on
RewriteRule ^(.*)$ http://127.0.0.1:48000/$1 [P]
```
6. Go to "Setup Node.js App", follow these settings, and Create
```bash
Node.js version = v16 above
Application mode = Production
Application root = public_html/example.yourdomain.com
Application URL = example.yourdomain.com
Application startup file = app.js
```
7. Copy the virtual environment path, open your terminal or SSH, paste it, and Enter
```bash
source /home/u123456/nodevenv/public_html/example.yourdomain.com/16/bin/activate && cd /home/u123456/public_html/example.yourdomain.com
```
8. Install the dependencies
```bash
yarn install
```
or
```bash
npm i
```
9. Build the project
```bash
yarn build
```
or
```sh
npm run build
```
10. Push the schema
```sh
npx prisma db push
```
11. Install pm2
```bash
npm install pm2@latest -g
```
or
```bash
yarn global add pm2
```
12. Run the app.js
```bash
npx pm2 start app.js
```
13. Now the endpoint should be available according to your environment variables configuration. Default is at `http://example.yourdomain.com`
Your API is ready, give it a try here => [DOCS](https://documenter.getpostman.com/view/18988925/2s8Z73zWbg)
### Install Zete-Panel
1. Create a new domain, e.g. yourdomain.com
2. Open the terminal or SHH to start cloning this repository to your domain directory
```bash
git clone https://github.com/cinderjk/zete.git public_html/yourdomain.com
```
3. Enter to the domain directory.
```bash
cd public_html/yourdomain.com
```
4. Install the dependencies
```bash
composer i
```
4. Create a new Database
5. Open file manager and edit the .env
```bash
APP_NAME=Zete
APP_ENV=local
APP_KEY=base64:oLpa/yTwIUUiFoPg5A17Ao15djIt6d4SOwUvdZyp5QZ=
APP_DEBUG=false
APP_URL=http://yourdomain.com
WA_API_URL=http://example.yourdomain.com
USE_JOB_QUEUE=false
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=your_zete_database
DB_USERNAME=your_zete_database_username
DB_PASSWORD=your_zete_database_password
```
Note:
WA_API_URL: please change it to your API endpoint
#### Using Queue
USE_JOB_QUEUE: set to `TRUE` If you want to use queue, you will need a cron jobs
run these commands on cron jobs
```bash
*/5 * * * * /usr/local/bin/php /home/u123456/public_html/yourdomain.com/artisan queue:work --max-time=300 >> /dev/null 2>&1
```
via terminal
```bash
php artisan queue:work
```
6. Run migration and key:generate, simply just
```bash
php artisan fresh:data
```
or
```bash
php artisan migrate:fresh --seed & php artisan key:generate
```
7. Create .htaccess file, and copy these
```bash
RewriteEngine on
RewriteCond %{REQUEST_URI} !^public
RewriteRule ^(.*)$ public/$1 [L]
```
8. Go to yourdomain.com
9. Login use username admin & 123
10. Go to Device > Add, and create new Device
11. Scan the QR with your whatsapp
12. Next, go to Messages > Add, and test it.
## Screenshots
### Login Page
### Dashboard
### Devices
### Scan Devices
### Add Message
### Profile
### Docs
## Tech Stack
**Client:** Livewire, Bootstrap
**Server:** NodeJs, Laravel
## Credit
- Baileys API: [ookamiiixd/baileys-api](https://github.com/ookamiiixd/baileys-api)
- Admin Template: [Now UI Dashboard](https://www.creative-tim.com/product/now-ui-dashboard)