{"id":28714989,"url":"https://github.com/herobot-id/herobot","last_synced_at":"2025-06-15T02:02:27.892Z","repository":{"id":297133921,"uuid":"994108708","full_name":"herobot-id/herobot","owner":"herobot-id","description":"Herobot is your 24/7 customer service assistant that helps you manage multi-channel customer conversations effortlessly.","archived":false,"fork":false,"pushed_at":"2025-06-13T03:36:14.000Z","size":820,"stargazers_count":55,"open_issues_count":14,"forks_count":22,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-13T04:33:22.094Z","etag":null,"topics":["ai","bot","chatbot","claude","customer-service","customer-support","gemini","intercom","laravel","openai","php","self-hosted","vue","vuejs","whatsapp"],"latest_commit_sha":null,"homepage":"https://herobot.id","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/herobot-id.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-01T08:15:04.000Z","updated_at":"2025-06-13T03:36:18.000Z","dependencies_parsed_at":"2025-06-13T04:25:19.424Z","dependency_job_id":null,"html_url":"https://github.com/herobot-id/herobot","commit_stats":null,"previous_names":["herobot-id/herobot"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/herobot-id/herobot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/herobot-id%2Fherobot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/herobot-id%2Fherobot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/herobot-id%2Fherobot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/herobot-id%2Fherobot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/herobot-id","download_url":"https://codeload.github.com/herobot-id/herobot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/herobot-id%2Fherobot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259910644,"owners_count":22930701,"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":["ai","bot","chatbot","claude","customer-service","customer-support","gemini","intercom","laravel","openai","php","self-hosted","vue","vuejs","whatsapp"],"created_at":"2025-06-15T02:00:45.932Z","updated_at":"2025-06-15T02:02:25.325Z","avatar_url":"https://github.com/herobot-id.png","language":"Vue","funding_links":["https://github.com/sponsors/dihak"],"categories":[],"sub_categories":[],"readme":"# Herobot App\n\nHerobot is your 24/7 customer service assistant that helps you manage multi-channel customer conversations effortlessly. With support for WhatsApp, WhatsApp Business, Instagram, Facebook Messenger, and TikTok (coming soon), Herobot enables businesses of all sizes to provide instant responses and superior customer service at scale.\n\n❤️ **Support this project**: If you find Herobot helpful, consider [sponsoring the project on GitHub](https://github.com/sponsors/dihak)\n\n![Image](https://github.com/user-attachments/assets/0e5d0d9a-8aea-4501-90e3-d5396f173104)\n\n## Deployment Options\n\nHerobot is an open-source project that offers flexible deployment options to suit your needs:\n\n1. **Herobot Cloud (herobot.id)**: Coming soon! Our managed cloud solution at [herobot.id](https://herobot.id) will provide a hassle-free setup with automatic updates and maintenance. Perfect for businesses that want to get started quickly without infrastructure management.\n\n2. **Self-Hosting**: Deploy Herobot on your own infrastructure for complete control and customization. Follow our setup guide below to host it on your servers.\n\nBoth options provide the same powerful features, letting you choose the deployment that best fits your requirements and privacy needs.\n\n## Key Features\n\n- **Multi-Channel Support**: Manage all your customer conversations from a single platform across multiple messaging channels\n- **Smart Business Tools**: Seamlessly integrate with your existing tools - from shipping cost checks to Google Forms, spreadsheets, and custom API integrations\n- **Instant Responses**: Provide 24/7 customer support, qualify lead automatically, and handle routine inquiries while your team focuses on high-value conversations\n- **Scalable Solution**: Perfect for both small businesses and large enterprises, with the ability to manage multiple channels and teams from one dashboard\n\n## Setup Guide\n\n### Quick Start Options\n\nFor a quick and easy setup without local installation, try these cloud-based options:\n\n\u003ca href=\"https://studio.firebase.google.com/import?url=https://github.com/herobot-id/herobot\"\u003e\n  \u003cpicture\u003e\n    \u003csource\n      media=\"(prefers-color-scheme: dark)\"\n      srcset=\"https://cdn.firebasestudio.dev/btn/try_dark_32.svg\"\u003e\n    \u003csource\n      media=\"(prefers-color-scheme: light)\"\n      srcset=\"https://cdn.firebasestudio.dev/btn/try_light_32.svg\"\u003e\n    \u003cimg\n      height=\"32\"\n      alt=\"Try in Firebase Studio\"\n      src=\"https://cdn.firebasestudio.dev/btn/try_blue_32.svg\"\u003e\n  \u003c/picture\u003e\n\u003c/a\u003e\n\u003ca href=\"https://gitpod.io/#https://github.com/herobot-id/herobot\"\u003e\n  \u003cimg src=\"https://gitpod.io/button/open-in-gitpod.svg\" alt=\"Open in Gitpod\" height=\"32\"\u003e\n\u003c/a\u003e\n\n### Local Development Setup\n\nTo set up the Herobot App locally, follow these steps:\n\n1. **Clone the Repository**:\n    ```sh\n    git clone git@github.com:herobot-id/herobot.git\n    ```\n\n2. **Set Up Environment Variables**:\n    ```sh\n    cp .env.example .env\n    ```\n   | Variable | Value | Notes |\n   |----------|-------|-------|\n   | `CHAT_SERVICE` | `gemini / openai / openrouter` | Set to **gemini** for Google Gemini chat (free tier). but if you have OpenAI, you can use OpenAI as well, or if you want to use openrouter, you can choose it as well. |\n   | `EMBEDDING_SERVICE` | `gemini / openai` | Set to **gemini** for embedding generation (free tier). but if you have OpenAI, you can use OpenAI as well. (openrouter doesn't have embedding models) |\n   | `GEMINI_API_KEY` | `\u003cyour-api-key\u003e` | Get an API-key at \u003chttps://aistudio.google.com/apikey\u003e. |\n   | `OPENAI_API_KEY` | `\u003cyour-api-key\u003e` | Get an API-key at \u003chttps://platform.openai.com/account/api-keys\u003e |\n   | `OPENROUTER_API_KEY` | `\u003cyour-api-key\u003e` | Get an API-key at \u003chttps://openrouter.ai/settings/keys\u003e |\n   | `GEMINI_MODEL` | `gemini-2.0-flash-lite` | (Optional but Better at RPM) |\n   | `OPENAI_MODEL` | `gpt-4o-mini` | (Optional but Better at RPM) |\n   | `OPENROUTER_MODEL` | `meta-llama/llama-3.1-8b-instruct:free` | (Recommended for free tier)\n\n4. **Start Services**\n   ```sh\n   # Start all services\n   docker compose up\n   ```\n   \n   This single command will automatically:\n   - Install Composer dependencies\n   - Install NPM dependencies\n   - Start the Laravel application\n   - Start the Vite development server\n   - Start the Reverb WebSocket server\n   - Start the WhatsApp server\n\n5. **Access the Application**:\n   - The application will be accessible on port 80. Open your browser and navigate to `http://localhost`.\n\n6. **Credentials**\n\n   Default user credentials are provided below:\n     \n   | Variable | Value |\n   |----------|-------|\n   | `Email` | `user@example.com` |\n   | `Password` | `password` |\n\n8. **Stopping Services**:\n   ```sh\n   # Stop all Docker containers and services\n   docker compose down\n   ```\n   \n   This will automatically stop all services including the Laravel application, Vite development server, Reverb WebSocket server, and WhatsApp server.\n\nBy following these steps, you will have the Herobot App up and running on your local machine, ready for development and testing.\n\n## Contributing\n\nWe welcome contributions from the community! Whether you're fixing bugs, adding new features, or improving documentation, your help is appreciated.\n\nPlease read our [Contributing Guide](CONTRIBUTING.md) for detailed information on:\n- Development setup and workflow\n- Code standards and best practices\n- Testing requirements\n- Pull request process\n- Channel integration guidelines\n\nFor bug reports and feature requests, please [open an issue](https://github.com/herobot-id/herobot/issues) on GitHub.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fherobot-id%2Fherobot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fherobot-id%2Fherobot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fherobot-id%2Fherobot/lists"}