{"id":36627465,"url":"https://github.com/frontapp/front-chat-sdk","last_synced_at":"2026-01-12T09:33:38.777Z","repository":{"id":213178198,"uuid":"718384367","full_name":"frontapp/front-chat-sdk","owner":"frontapp","description":"Utilities for instantiating Front Chat.","archived":false,"fork":false,"pushed_at":"2025-07-04T00:11:02.000Z","size":508,"stargazers_count":3,"open_issues_count":0,"forks_count":4,"subscribers_count":8,"default_branch":"main","last_synced_at":"2026-01-11T22:32:49.309Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://front.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/frontapp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2023-11-14T00:51:01.000Z","updated_at":"2025-07-04T00:10:07.000Z","dependencies_parsed_at":"2023-12-19T05:10:42.638Z","dependency_job_id":"39f8a7af-97be-4a49-85ca-cf737f183c46","html_url":"https://github.com/frontapp/front-chat-sdk","commit_stats":null,"previous_names":["frontapp/front-chat-sdk"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/frontapp/front-chat-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontapp%2Ffront-chat-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontapp%2Ffront-chat-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontapp%2Ffront-chat-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontapp%2Ffront-chat-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/frontapp","download_url":"https://codeload.github.com/frontapp/front-chat-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontapp%2Ffront-chat-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28337728,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T06:09:07.588Z","status":"ssl_error","status_checked_at":"2026-01-12T06:05:18.301Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2026-01-12T09:33:38.200Z","updated_at":"2026-01-12T09:33:38.772Z","avatar_url":"https://github.com/frontapp.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![Apache 2.0 License][license-shield]][license-url]\n\n\u003c!-- NPM PACKAGE LOGO --\u003e\n\n\u003ca href=\"https://badge.fury.io/js/front-chat-sdk\"\u003e\u003cimg src=\"https://badge.fury.io/js/front-chat-sdk.svg\" alt=\"npm version\" height=\"18\" /\u003e\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/frontapp/front-chat-sdk\"\u003e\n   \u003cimg src=\"https://github.com/frontapp/front-chat-sdk/raw/main/public/chatWidget.svg\" alt=\"Logo\" height=\"100\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003efront-chat-sdk\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\n  Utilities and examples for launching Front Chat.\n  \u003cbr /\u003e\n  \u003ca href=\"https://dev.frontapp.com/docs/chat-sdk-reference\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n  \u003cbr /\u003e\n  \u003cbr /\u003e\n  \u003ca href=\"https://front.com/\"\u003eFront\u003c/a\u003e\n  ·\n  \u003ca href=\"https://github.com/frontapp/front-chat-sdk/issues\"\u003eReport Bug\u003c/a\u003e\n  ·\n  \u003ca href=\"https://github.com/frontapp/front-chat-sdk/issues\"\u003eRequest Feature\u003c/a\u003e\n\u003c/p\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#running-front-chat-sdk-locally\"\u003eRunning front-chat-sdk locally\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#install-and-run\"\u003eInstall and run\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#feedback\"\u003eFeedback\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\n\u003cp align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://github.com/frontapp/front-chat-sdk/raw/main/public/screenshotDark.png\"\u003e\n    \u003cimg src=\"https://github.com/frontapp/front-chat-sdk/raw/main/public/screenshot.png\" alt=\"front-chat-sdk Screen Shot\" height=\"480\"\u003e\n  \u003c/picture\u003e\n\u003c/p\u003e\n\nThis repository contains examples to demonstrate how Front Chat can be launched on a variety of web pages. The core example demonstrates how the `useFrontChat` hook can be applied to quickly launch a chat widget in a React application, and there is also an example of using the generic `initialize` function to launch Front Chat on any kind of web page.\n\nFor more advanced use cases, there are two additional helpers: `useFrontChatBoot` and `boot`.\n\nTo learn more about Front Chat, check out [this article](https://help.front.com/en/articles/2062) from Front.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Getting Started\n\nWe now have an \u003ca href=\"https://www.npmjs.com/package/front-chat-sdk\"\u003enpm package\u003c/a\u003e available!\n\n```sh\nnpm i front-chat-sdk\n```\n\n```ts\nimport {initialize} from 'front-chat-sdk/helpers';\nimport {useFrontChat} from 'front-chat-sdk/hooks';\nimport type {FrontChat} from 'front-chat-sdk/types';\n```\n\nSee [examples](https://github.com/frontapp/front-chat-sdk/tree/main/examples) for more on how to use front-chat-sdk.\n\n## Running front-chat-sdk locally\n\n### Install and Run\n\n1. Clone the repo\n   ```sh\n   git clone https://github.com/frontapp/front-chat-sdk.git\n   ```\n2. Install packages\n   ```sh\n   npm install\n   ```\n3. Run the example application\n   ```sh\n   npm run dev\n   ```\n\nAfter the last command, the example application can be accessed at http://localhost:5173/\n\n\u003c!-- USAGE EXAMPLES --\u003e\n\n### Usage\n\nThere are four helpers provided in this repository, and each of them is used in the [examples](https://github.com/frontapp/front-chat-sdk/tree/main/examples) directory.\n\nWe have also provided additional examples for common use cases. These examples use React, but the general principles should work for any application.\n\n- How to embed a Front Chat widget [directly in a page](https://github.com/frontapp/front-chat-sdk/tree/main/examples/react-embed-front-chat).\n- How to initialize a Front Chat widget [with a verified user](https://github.com/frontapp/front-chat-sdk/tree/main/examples/react-verified-user).\n\n#### Quick-start Helpers\n\n- [`initialize`](https://github.com/frontapp/front-chat-sdk/blob/main/lib/helpers/initialize/index.ts)\n  - An async function that boots and initializes a Front Chat widget. The returned `Promise` is only resolved once the chat widget application is fully running and initialized inside its iframe.\n- [`useFrontChat`](https://github.com/frontapp/front-chat-sdk/blob/main/lib/hooks/use-front-chat/index.ts)\n  - A React hook that boots and initializes a Front Chat widget while adhering to the React component lifecycle.\n\n#### Advanced Helpers\n\n- [`boot`](https://github.com/frontapp/front-chat-sdk/blob/main/lib/helpers/boot/index.ts)\n  - An async function that boots the Front Chat widget and returns helpers to interact with the Front Chat SDK. The returned `Promise` is only resolved once the chat widget application is fully running inside its iframe.\n- [`useFrontChatBoot`](https://github.com/frontapp/front-chat-sdk/blob/main/lib/hooks/use-front-chat-boot/index.ts)\n  - A React hook that boots the Front Chat widget and provides helpers to initialize the application while adhering to the React component lifecycle.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- FEEDBACK --\u003e\n\n## Feedback\n\nAlthough this package is maintained by Front, feedback is **greatly appreciated**. Feel free to open an issue if you have any suggestions as to how this repository and its examples could be improved.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTACT --\u003e\n\n## Contact\n\nFront Support - [https://help.front.com/en/contact-us](https://help.front.com/en/contact-us)\n\nPlease mention that you are experiencing issues with Front Chat or `front-chat-sdk`, so that they can direct you to a member of the Live Chat team.\n\nProject Link: [https://github.com/frontapp/front-chat-sdk](https://github.com/frontapp/front-chat-sdk)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- LICENSE --\u003e\n\n## License\n\nDistributed under the Apache 2.0 License. See [`LICENSE`][license-url] for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n\n[contributors-shield]: https://img.shields.io/github/contributors/frontapp/front-chat-sdk.svg?style=for-the-badge\n[contributors-url]: https://github.com/frontapp/front-chat-sdk/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/frontapp/front-chat-sdk.svg?style=for-the-badge\n[forks-url]: https://github.com/frontapp/front-chat-sdk/network/members\n[stars-shield]: https://img.shields.io/github/stars/frontapp/front-chat-sdk.svg?style=for-the-badge\n[stars-url]: https://github.com/frontapp/front-chat-sdk/stargazers\n[issues-shield]: https://img.shields.io/github/issues/frontapp/front-chat-sdk.svg?style=for-the-badge\n[issues-url]: https://github.com/frontapp/front-chat-sdk/issues\n[license-shield]: https://img.shields.io/github/license/frontapp/front-chat-sdk.svg?style=for-the-badge\n[license-url]: https://github.com/frontapp/front-chat-sdk/blob/master/LICENSE.txt\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrontapp%2Ffront-chat-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrontapp%2Ffront-chat-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrontapp%2Ffront-chat-sdk/lists"}