{"id":21124509,"url":"https://github.com/zauberware/hermine-chat","last_synced_at":"2026-04-02T13:25:27.626Z","repository":{"id":228965130,"uuid":"768204830","full_name":"zauberware/hermine-chat","owner":"zauberware","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-11T18:03:48.000Z","size":3766,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-14T02:16:00.381Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zauberware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-06T16:55:39.000Z","updated_at":"2024-10-11T18:03:52.000Z","dependencies_parsed_at":"2024-04-16T11:33:01.539Z","dependency_job_id":"c3f81596-e07e-447f-807a-4a6a69f5abb1","html_url":"https://github.com/zauberware/hermine-chat","commit_stats":null,"previous_names":["zauberware/hermine-chat"],"tags_count":57,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zauberware%2Fhermine-chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zauberware%2Fhermine-chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zauberware%2Fhermine-chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zauberware%2Fhermine-chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zauberware","download_url":"https://codeload.github.com/zauberware/hermine-chat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225465299,"owners_count":17478522,"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":[],"created_at":"2024-11-20T04:16:46.801Z","updated_at":"2025-11-27T19:02:08.280Z","avatar_url":"https://github.com/zauberware.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hermine-Chat\n\nHermine-Chat is a react package to integrate a hermine.ai-based chat component on any website.\nCome and create and account on [hermine.ai](https://hermine.ai) to get started. Build custom GPTs and profit from the knowhow of talented data engineers, software-developers and product owners.\n\n## Integration\n\nIt doesn't matter if it's hosted via a bundled javascript environment or plain javascript.\n\n### Integration via npm\n\nTo install the package run:\n\n```bash\nnpm install --save @zauberware/hermine-chat\n```\n\nSetup the Chat component by doing this:\n\n```javascript\nimport HermineChat from \"@zauberware/hermine-chat\";\nHermineChat({\n  accountId: \"\u003cyour-account-id\u003e\",\n  agentSlug: \"\u003cyour-agent-slug\u003e\",\n  // your settings going in here\n});\n```\n\n### Integration via CDN\n\nAdd import script tag. To use a specific version number just add the following snippet:\n\n```html\n\u003cscript\n  type=\"module\"\n  src=\"https://cdn.zauberware.com/hermine-chat/versions/v\u003cVERION_NUMBER\u003e/esm/index.js\"\n  crossorigin=\"anonymous\"\n\u003e\u003c/script\u003e\n```\n\nIf you always want to fetch the most recent version load the data via the following snippet, but be aware that there might be some breaking changes.\n\n```html\n\u003cscript\n  type=\"module\"\n  src=\"https://cdn.zauberware.com/hermine-chat/current/esm/index.js\"\n  crossorigin=\"anonymous\"\n\u003e\u003c/script\u003e\n```\n\nSetup the Chat component by doing this:\n\n```javascript\nwindow.HermineChat({\n  accountId: \"\u003cyour-account-id\u003e\",\n  agentSlug: \"\u003cyour-agent-slug\u003e\",\n  // your settings going in here\n});\n```\n\nIf you put this in your html template file, do not forget to put it inside `\u003cscript type=\"module\"\u003e`-tags.\n\n## Configuration Options\n\n| Option                      | Required | Description                                                       | Type                            | Example                                |\n| --------------------------- | -------- | ----------------------------------------------------------------- | ------------------------------- | -------------------------------------- |\n| `accountId`                 | yes      | Your accountId generated by hermine.ai                            | `uuid`                          | `11111111-2222-3333-4444-555555555555` |\n| `agentSlug`                 | yes      | Your agentSlug generated by hermine.ai                            | `slug`                          | `hermine-gpt`                          |\n| `location`                  | -        | The location of the chat button.                                  | `'top' \\| 'center' \\| 'bottom'` | `hermine-gpt`                          |\n| `chatTitle`                 | -        | The title of the chat window.                                     | `string`                        | `Hermine-Chat`                         |\n| `chatTitleColor`            | -        | The color of the title of the chat window.                        | `css color`                     | `rgb(15, 15, 15) \\| 'red' \\| '#e20'`   |\n| `chatDescription`           | -        | The description of the chat window.                               | `string`                        | `Hermine-Chat`                         |\n| `spacingBottom`             | -        | Space to bottom of screen (in addition with location 'bottom').   | `css size`                      | `10px \\| 10% \\| 10vh`                  |\n| `spacingTop`                | -        | Space to top of screen (in addition with location 'top').         | `css size`                      | `10px \\| 10% \\| 10vh`                  |\n| `spacingRight`              | -        | Space to right of screen.                                         | `css size`                      | `10px \\| 10% \\| 10vh`                  |\n| `floatingButtonBorderColor` | -        | Border color of the floating button.                              | `css color`                     | `rgb(15, 15, 15) \\| 'red' \\| '#e20'`   |\n| `floatingButtonWidth`       | -        | Width of the floating button.                                     | `number \\| string`              | `70 \\| '70px' \\| '5rem'`               |\n| `floatingButtonHeight`      | -        | Height of the floating button.                                    | `number \\| string`              | `70 \\| '70px' \\| '5rem'`               |\n| `buttonBackgroundColor`     | -        | Background color of the send button.                              | `css color`                     | `rgb(15, 15, 15) \\| 'red' \\| '#e20'`   |\n| `buttonColor`               | -        | Text color of send button.                                        | `css color`                     | `rgb(15, 15, 15) \\| 'red' \\| '#e20'`   |\n| `messageColor`              | -        | Text color of ai message bubbles.                                 | `css color`                     | `rgb(15, 15, 15) \\| 'red' \\| '#e20'`   |\n| `messageBackgroundColor`    | -        | Background color of ai message bubbles.                           | `css color`                     | `rgb(15, 15, 15) \\| 'red' \\| '#e20'`   |\n| `showConversationManagment` | -        | Enable \"Show more\" button to route to hermine conversations view. | `boolean`                       | `true`                                 |\n| `useCustomLogo`             | -        | Using the custom logo set on hermine.ai.                          | `boolean`                       | `true`                                 |\n\n## FAQ\n\n### Is there a way to open the chatwindow from outside?\n\nYou can open the chatwindow by adding a element with the class `hermine-chat-opener`. With the class `hermine-chat-toggler` you also can close the window with a click on those.\n\nIf you want to open the chat window via an url, you can add a the following query parameter to the url: `?hermine_chat_open=true` for example `https://hermine.ai/agents?hermine_chat_open=true.\n\n### How to change the avatar in the ai chat messages?\n\nThe image from the floating button is loaded from the hermine.ai application. The property used for the image is the `ai_icon`.\n\n### How to change the avatar in the ai chat messages?\n\nThe image from the floating button is loaded from the hermine.ai application. The property used for the image is the `ai_icon`.\n\n## Development\n\nTo contribute in the development in this application you need something like a container application.\nFor example you could use [this](https://github.com/ChrKahl/hermine-chat-container) sveltekit application.\nAfter you cloned the package, make sure to add this package in the container application with your relative path.\nFor example:\n\n```bash\nnpm uninstall @zauberware/hermine-chat\nnpm i ../../hermine-chat\n```\n\nWhen making changes on the project you need to rebuild it. This will work with executing the following command:\n\n```bash\nnpm run dev\n```\n\nSome times the container app shows a 500 error message. If those appear, just restart it with `npm run dev`\n\n## Release\n\n### In short\n`npm version patch -m \"chore(release): %s\"`\n`git push origin main --follow-tags`\n\n### 1. Bump the version\n\n```bash\nnpm version patch -m \"chore(release): %s\"\n```\n\n- **Purpose:**  \n  Increments your project's version number in `package.json` and `package-lock.json` according to [Semantic Versioning](https://semver.org/).\n  - `patch`: Increments the last number (e.g., `1.0.0` → `1.0.1`). Use for bug fixes or small changes.\n  - `-m \"chore(release): %s\"`: Sets the commit message, where `%s` is replaced with the new version (e.g., `chore(release): 1.0.1`).\n- **What happens:**  \n  - Updates version numbers.\n  - Creates a Git commit with the changes.\n  - Creates a Git tag for the new version.\n\n### 2. Push changes and tags\n\n```bash\ngit push origin main --follow-tags\n```\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzauberware%2Fhermine-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzauberware%2Fhermine-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzauberware%2Fhermine-chat/lists"}