Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codespearhead/baileys-quickstart
The quickstart with Baileys®' WhatsApp Web API you've always wanted
https://github.com/codespearhead/baileys-quickstart
baileys baileys-bot whatsapp whatsapp-automation whatsapp-bot
Last synced: 3 months ago
JSON representation
The quickstart with Baileys®' WhatsApp Web API you've always wanted
- Host: GitHub
- URL: https://github.com/codespearhead/baileys-quickstart
- Owner: codespearhead
- License: gpl-3.0
- Created: 2023-01-30T21:35:30.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-26T06:39:41.000Z (over 1 year ago)
- Last Synced: 2024-12-03T12:55:04.500Z (3 months ago)
- Topics: baileys, baileys-bot, whatsapp, whatsapp-automation, whatsapp-bot
- Language: TypeScript
- Homepage:
- Size: 69.3 KB
- Stars: 15
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Baileys® Quickstart
The quickstart with Baileys®' WhatsApp Web API you've always wanted
## QuickStart with Docker (Recommended)
```sh
docker compose up
```
## Manual QuickStart
> **Note**: You'll need the latest LTS version of Node installed on your system.
1. Clone the repository and cd into it:
```
git clone https://github.com/codespearhead/baileys-quickstart
cd baileys-quickstart
```
2. Download the dependencies used in the minimal reproducible example
```
npm i
```
3. Transpile the Server.ts:
```
npm run build
```
4. Run the minimal working example:
```
npm start
```
Note that method readMessage from ServiceLayer.js will be called upon receiving a message. Implement function realBusinessLogic in that file to override the default replies, as shown in branch "whatsapp-click-to-chat".
## Usage
After scanning the QRCode, send "ping" (without quotes) to the WhatsApp account logged into the program. It'll send "pong" back.
## Disclaimers
> **Warning**: WhatsApp's averse to any type of automation that it considers to be "Harm[ful] to WhatsApp or [their] Users" on its platform, unless it's coming from an official WhatsApp Businesses API partner. So, it’s advisable to read WhatsApp's [Terms of Service](https://www.whatsapp.com/legal/terms-of-service) in order not to break them. Use this software at your own risk.
> **Note**: This repository was built upon the currently official [quickstart](https://github.com/WhiskeySockets/Baileys/blob/master/Example/example.ts) of Baileys®, which as of today doesn't qualify as a [MRE](https://en.wikipedia.org/wiki/Minimal_reproducible_example).
> **Note**: We are not affiliated, associated, authorized, endorsed by or in any way officially connected to WhatsApp, LLC. ([www.whatsapp.com](https://www.whatsapp.com)).
> **Note**: We are not affiliated, associated, authorized, endorsed by or in any way officially connected to Baileys®. ([https://github.com/WhiskeySockets/Baileys](https://github.com/WhiskeySockets/Baileys)).
> **Note**:
> Copyright Disclaimer under section 107 of the Copyright Act 1976, allowance is made for “fair use” for purposes such as criticism, comment, news reporting, teaching, scholarship, education and research.
> Fair use is a use permitted by copyright statute that might otherwise be infringing.
> Non-profit, educational or personal use tips the balance in favor of fair use.