This is a template for creating WhatsApp bots.
This template has everything set up for you to create a WhatsApp bot, so you can start coding your bot right away, without needing to worry about any configuration.
It has TypeScript, Docker, ESLint, and Prettier already configured, so you have a nice developer experience and a production-ready bot.
- Node.js: You need to have Node.js installed on your computer to run this bot. You can download it here.
In the project directory, you can run:
Installs every dependency needed for the project.
Runs the app in the development mode.
The app will reload every time you save a file.
You will also see any lint errors/warnings in the console.
yarn devandnpm run devdo the same.
Runs the app in the production mode.
Before running the app, it will run the linter, format code with Prettier, and build the project.
Builds the app for production to the build folder.
Your app is ready to be deployed!
yarn prodandnpm run proddo the same, and also run the app after building it.
Runs the linter and logs every error and warning to the console.
yarn lint:fixandnpm run lint:fixfix every autofixable error/warning.
Runs Prettier and logs every error and warning to the console.
yarn prettier:fixandnpm run prettier:fixfix every autofixable error/warning.
Runs both the linter and Prettier and logs every error and warning to the console.
yarn check:fixandnpm run check:fixfix every autofixable error/warning.
A normal Dockerfile for a Node.js app won't work for this bot, as the whatsapp-web.js library uses Puppeteer, and needs Chromium to run.
This project's Dockerfile handles every installation, and sets the whole environment needed for the bot to run and be authenticated.
If the Docker image is built in a directory that has a .wwebjs_auth folder, it will use that file to authenticate and the container will start the bot without further authentication. If not, a QR code will be logged to the console and the user will have to scan it to authenticate.
You can use Docker to run your app. This project has a multi-stage build process so your final image doesn't have any TypeScript files nor dev dependencies, resulting in a smaller image size.
To build your image run: docker build -t <image-name> .
To run your image run: docker run -p 80:80 <image-name>
If you haven't used Docker before, you can get started with it here.
Contributions are more than welcome!
We think that you might have great ideas to make this project even better. If you do, please create a pull request and/or issue following the contribution guidelines.
Give a ⭐️ if this project helped you!
Copyright © 2022 Toti Muñoz.
This project is MIT licensed.
This project was made with ❤ and TypeScript