{"id":18656660,"url":"https://github.com/zendesk/zopim-chat-web-sdk-sample-app","last_synced_at":"2025-08-21T07:32:53.524Z","repository":{"id":45527226,"uuid":"70778506","full_name":"zendesk/zopim-chat-web-sdk-sample-app","owner":"zendesk","description":"Zendesk Chat Web SDK sample app developed using React","archived":false,"fork":false,"pushed_at":"2024-04-08T10:37:26.000Z","size":692,"stargazers_count":98,"open_issues_count":8,"forks_count":60,"subscribers_count":312,"default_branch":"master","last_synced_at":"2025-06-09T15:45:51.284Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://api.zopim.com/web-sdk","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zendesk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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,"zenodo":null}},"created_at":"2016-10-13T07:02:52.000Z","updated_at":"2025-05-10T15:29:30.000Z","dependencies_parsed_at":"2025-06-09T15:46:52.017Z","dependency_job_id":null,"html_url":"https://github.com/zendesk/zopim-chat-web-sdk-sample-app","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zendesk/zopim-chat-web-sdk-sample-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fzopim-chat-web-sdk-sample-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fzopim-chat-web-sdk-sample-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fzopim-chat-web-sdk-sample-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fzopim-chat-web-sdk-sample-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zendesk","download_url":"https://codeload.github.com/zendesk/zopim-chat-web-sdk-sample-app/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fzopim-chat-web-sdk-sample-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271444424,"owners_count":24760803,"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","status":"online","status_checked_at":"2025-08-21T02:00:08.990Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":"2024-11-07T07:24:38.256Z","updated_at":"2025-08-21T07:32:52.872Z","avatar_url":"https://github.com/zendesk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"⚠️ Use of this software is subject to important terms and conditions as set forth in the License file ⚠️\n\n# Zendesk Chat Web SDK Sample App\n\nThis sample app demonstrates how to build a simple chat widget using the [Zendesk Chat Web SDK](https://api.zopim.com/web-sdk).\n\nThe sample app is built using the [React](https://facebook.github.io/react/) framework and [Redux](http://redux.js.org/) architecture. However, you are free to use any other JavaScript framework to develop your own chat widget.\n\nScreenshots:\n\n| Normal                             | Docked                             |\n| :--------------------------------: | :--------------------------------: |\n| ![](screenshots/normal_widget.png) | ![](screenshots/docked_widget.png) |\n\n## Getting Started\n### Setup\nYou will need:\n- [Node.js](http://nodejs.org/) at least version 4.5.0\n- [npm](https://www.npmjs.com/)\n\nThen run:\n```\nnpm install\n```\nto install all the dependencies.\n\nNext, download the latest version of the SDK (refer to the [Getting the SDK](https://api.zopim.com/web-sdk/#getting-the-sdk) section of the documentation). Make sure the file is named `web-sdk.js` and place it in the `vendor` folder.\n\n### Running\nTo compile and run the sample app, run the following command:\n```\nnpm start\n```\n\nThis would open your browser pointing at [127.0.0.1:8000](http://127.0.0.1:8000).\n\n### Configuration\nTo set your Zendesk Chat account key, navigate to the configuration file at [`src/config/base.js`](src/config/base.js).\n\nModify the content of the file as follows:\n```javascript\nexport default {\n\tACCOUNT_KEY: 'YOUR_ACCOUNT_KEY'\n}\n```\n\n## Compiling the Widget\nTo compile the the widget, run `npm run dist`.\n\nAt the end of the compilation, you can find the widget at `dist/assets/widget.js`, which you can now use to embed in your website via a `script` tag as follows:\n\n```html\n\u003cscript type=\"text/javascript\" src=\"/path/to/widget.js\"\u003e\u003c/script\u003e\n```\n## Testing locally \nIf you are using `localhost` to test the sample code, you will get visitor session disconnections on page change or refresh. This is due to `localhost` storing but not persisting the visitor cookie. Each page change will cause the visitor to re-register with a new cookie value. \n\nTo get around this, use the IP address of the machine (ex. `https://127.0.0.1`) or assign a local domain name.\n\n## Contributions\nPull requests are welcome.\n\n## Bugs\nPlease submit bug reports to [Zendesk](https://support.zendesk.com/requests/new).\n\n## License\nCopyright 2016 Zendesk, Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License.\n\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzendesk%2Fzopim-chat-web-sdk-sample-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzendesk%2Fzopim-chat-web-sdk-sample-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzendesk%2Fzopim-chat-web-sdk-sample-app/lists"}