{"id":41235900,"url":"https://github.com/inkeep/starter-template-inkeep-widgets-react","last_synced_at":"2026-01-23T01:03:27.702Z","repository":{"id":181019280,"uuid":"635098159","full_name":"inkeep/starter-template-inkeep-widgets-react","owner":"inkeep","description":null,"archived":false,"fork":false,"pushed_at":"2024-07-19T17:59:20.000Z","size":1507,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-03T08:28:11.579Z","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/inkeep.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":"2023-05-02T00:52:00.000Z","updated_at":"2024-07-28T04:33:15.000Z","dependencies_parsed_at":"2023-09-27T22:13:08.551Z","dependency_job_id":"b6ca6f2b-ddeb-41d0-9bc5-8804f9cbaa45","html_url":"https://github.com/inkeep/starter-template-inkeep-widgets-react","commit_stats":null,"previous_names":["inkeep/starter-template-inkeep-widgets"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/inkeep/starter-template-inkeep-widgets-react","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkeep%2Fstarter-template-inkeep-widgets-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkeep%2Fstarter-template-inkeep-widgets-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkeep%2Fstarter-template-inkeep-widgets-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkeep%2Fstarter-template-inkeep-widgets-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inkeep","download_url":"https://codeload.github.com/inkeep/starter-template-inkeep-widgets-react/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkeep%2Fstarter-template-inkeep-widgets-react/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28676488,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T01:00:35.747Z","status":"ssl_error","status_checked_at":"2026-01-23T01:00:19.529Z","response_time":144,"last_error":"SSL_read: 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-23T01:03:27.581Z","updated_at":"2026-01-23T01:03:27.643Z","avatar_url":"https://github.com/inkeep.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Getting Started with Inkeep Widget Library\n\n## To run this sandbox\n\n### Install deps\n\nWe'll use bun for the rest of this example, but should work similarly across `npm`, `yarn`, and `pnpm`\n\n``` bash\nbun install\n```\n\n\n### Add environment variables\n\nSee below on adding the necessary env vars\n\n### Start the dev server\n\n``` bash\nbun start\n```\n\nThat's it! Play around with the `sharedSettings` file to enable different features.\n\n## To get started integrating into your own app\n\n## Installing packages\n\n``` bash\nbun add @inkeep/uikit@latest\n```\n\n### Peer dependencies\n\nThe uikit library requires `react` and `react-dom` version 18 as peer dependencies. If you use an older version for your project, you can use the JS Script version instead, see the quickstart [here](https://github.com/inkeep/starter-template-widgets-embed).\n\n## Add environment variables\n\nTo call the chat and search service, you need to provide a few properties to the widget(s). In this sample project, they are stored as environment variables. Create an .env file with the following keys and fill in the values:\n\n\n```ts\nINKEEP_INTEGRATION_API_KEY=\nINKEEP_INTEGRATION_ID=\nINKEEP_ORGANIZATION_ID=\n```\n\nModify for your project as needed, e.g. for Vite, prefix with `VITE`\n\n## Configure the widget\n\nSee the `sharedSettings` example files to see the available configuration properties. These include text, theming, and other functionality settings.\n\n## Next.js and server-side apps\n\nIn SSR applications, the Inkeep React components should be loaded client side.\n\nIn Next.js, you can use dynamic imports like so:\n\n``` js\nconst InkeepEmbeddedChatWidget = dynamic(\n  () =\u003e\n    import(\"@inkeep/uikit\").then(\n      (mod) =\u003e mod.InkeepEmbeddedChatWidget\n    ),\n  {\n    ssr: false,\n  }\n);\n\n// in your component:\n// \u003cInkeepEmbeddedChatWidget {...inkeepAIChatWidgetProps} /\u003e\n```\n\nOr in Next.js 13, you can add the `'use client'` directive at the top of a page where you use the component.\n\n## Custom Styling\n\nIf you would like to override particular styles in a widget, this can be done via stylesheets that are passed to the widget baseSettings, either an array of stylesheet urls or an array of link components. See `style-overrides.css` in the public folder for some examples.\n\n``` ts\nconst InkeepEmbeddedChatSettings: InkeepEmbeddedChatProps = {\n  baseSettings: {\n    ...inkeepBaseSettings,\n    theme: {\n        stylesheetUrls: ['/style-overrides.css'],\n        stylesheets: [\u003clink rel=\"stylesheet\" href=\"/overrides.css\" /\u003e],\n    }\n   },\n  aiChatSettings: { ...inkeepAIChatSettings },\n};\n\nexport const EmbeddedChat = () =\u003e {\n  return (\n    \u003cInkeepEmbeddedChat {...InkeepEmbeddedChatSettings} /\u003e\n  );\n};\n```\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n### `bun start`\n\nRuns the app in the development mode.\\\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\nThe page will reload if you make edits.\\\nYou will also see any lint errors in the console.\n\n### `bun test`\n\nLaunches the test runner in the interactive watch mode.\\\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\n### `bun run build`\n\nBuilds the app for production to the `build` folder.\\\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\nThe build is minified and the filenames include the hashes.\\\nYour app is ready to be deployed!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finkeep%2Fstarter-template-inkeep-widgets-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finkeep%2Fstarter-template-inkeep-widgets-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finkeep%2Fstarter-template-inkeep-widgets-react/lists"}