{"id":17482281,"url":"https://github.com/totigm/whatsapp-bot-template","last_synced_at":"2025-04-10T11:53:18.998Z","repository":{"id":116950379,"uuid":"530431736","full_name":"totigm/whatsapp-bot-template","owner":"totigm","description":"This is a template for creating WhatsApp bots","archived":false,"fork":false,"pushed_at":"2022-09-01T07:42:05.000Z","size":86,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-19T02:16:27.912Z","etag":null,"topics":["bot","template","typescript","whatsapp","whatsapp-bot","whatsapp-web"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/totigm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-29T23:46:38.000Z","updated_at":"2024-07-18T18:46:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"6e1c77fa-81b8-4221-8dde-e3c9a258055f","html_url":"https://github.com/totigm/whatsapp-bot-template","commit_stats":{"total_commits":12,"total_committers":2,"mean_commits":6.0,"dds":0.08333333333333337,"last_synced_commit":"7fea1524142e7b7fbba56f7bdd918c8e6fb392e5"},"previous_names":[],"tags_count":0,"template":true,"template_full_name":"totigm/typescript-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totigm%2Fwhatsapp-bot-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totigm%2Fwhatsapp-bot-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totigm%2Fwhatsapp-bot-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totigm%2Fwhatsapp-bot-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/totigm","download_url":"https://codeload.github.com/totigm/whatsapp-bot-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248215193,"owners_count":21066622,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","template","typescript","whatsapp","whatsapp-bot","whatsapp-web"],"created_at":"2024-10-18T23:05:20.165Z","updated_at":"2025-04-10T11:53:18.993Z","avatar_url":"https://github.com/totigm.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WhatsApp bot template\n\nThis is a template for creating WhatsApp bots.\n\nThis 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.\\\nIt has TypeScript, Docker, ESLint, and Prettier already configured, so you have a nice developer experience and a production-ready bot.\n\n## 📋 Prerequisites\n\n-   [**Node.js**](https://nodejs.org): You need to have Node.js installed on your computer to run this bot. You can download it [here](https://nodejs.org/en/download).\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n### `yarn` or `npm i`\n\nInstalls every dependency needed for the project.\n\n### `yarn start` or `npm start`\n\nRuns the app in the development mode.\\\nThe app will reload every time you save a file.\n\nYou will also see any lint errors/warnings in the console.\n\n\u003e _`yarn dev` and `npm run dev` do the same._\n\n### `yarn prod` or `npm run prod`\n\nRuns the app in the production mode.\n\nBefore running the app, it will run the linter, format code with Prettier, and build the project.\n\n### `yarn build` or `npm run build`\n\nBuilds the app for production to the `build` folder.\n\nYour app is ready to be deployed!\n\n\u003e _`yarn prod` and `npm run prod` do the same, and also run the app after building it._\n\n### `yarn lint` or `npm run lint`\n\nRuns the linter and logs every error and warning to the console.\n\n\u003e _`yarn lint:fix` and `npm run lint:fix` fix every autofixable error/warning._\n\n### `yarn prettier` or `npm run prettier`\n\nRuns Prettier and logs every error and warning to the console.\n\n\u003e _`yarn prettier:fix` and `npm run prettier:fix` fix every autofixable error/warning._\n\n### `yarn check` or `npm run check`\n\nRuns both the linter and Prettier and logs every error and warning to the console.\n\n\u003e _`yarn check:fix` and `npm run check:fix` fix every autofixable error/warning._\n\n## 🚀 Deploying\n\nA normal Dockerfile for a Node.js app won't work for this bot, as the [whatsapp-web.js](https://wwebjs.dev) library uses Puppeteer, and needs Chromium to run.\\\nThis project's [Dockerfile](./Dockerfile) handles every installation, and sets the whole environment needed for the bot to run and be authenticated.\n\nIf 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.\n\n## 🐳 Docker\n\nYou can use [Docker](https://www.docker.com) 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.\n\nTo [build your image](https://docs.docker.com/engine/reference/commandline/build) run: `docker build -t \u003cimage-name\u003e .`\n\nTo [run your image](https://docs.docker.com/engine/reference/run) run: `docker run -p 80:80 \u003cimage-name\u003e`\n\n\u003e If you haven't used Docker before, you can get started with it [here](https://www.docker.com/get-started).\n\n## 👤 Author\n\n\u003ca href=\"https://github.com/totigm\" target=\"_blank\"\u003e\n  \u003cimg alt=\"GitHub: totigm\" src=\"https://img.shields.io/github/followers/totigm?label=Follow @totigm\u0026style=social\"\u003e\n\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://twitter.com/totigm8\" target=\"_blank\"\u003e\n  \u003cimg alt=\"Twitter: totigm8\" src=\"https://img.shields.io/twitter/follow/totigm8?style=social\" /\u003e\n\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://linkedin.com/in/totigm\" target=\"_blank\"\u003e\n  \u003cimg alt=\"LinkedIn: totigm\" src=\"https://img.shields.io/badge/LinkedIn-@totigm-green?style=social\u0026logo=linkedin\" /\u003e\n\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://www.npmjs.com/~totigm\" target=\"_blank\"\u003e\n  \u003cimg alt=\"NPM: totigm\" src=\"https://img.shields.io/badge/NPM-@totigm-green?style=social\u0026logo=npm\" /\u003e\n\u003c/a\u003e\n\n## 🤝 Contributing\n\nContributions are more than welcome!\n\nWe 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](./docs/CONTRIBUTING.md).\n\n## ⭐️ Show your support\n\nGive a ⭐️ if this project helped you!\n\n## 📝 License\n\nCopyright © 2022 [Toti Muñoz](https://github.com/totigm).\u003cbr /\u003e\nThis project is [MIT](https://github.com/totigm/ts-package-template/blob/master/LICENSE) licensed.\n\n---\n\nThis project was made with ❤ and TypeScript\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftotigm%2Fwhatsapp-bot-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftotigm%2Fwhatsapp-bot-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftotigm%2Fwhatsapp-bot-template/lists"}