{"id":21459761,"url":"https://github.com/lucybot-inc/embed-sample","last_synced_at":"2025-10-17T10:24:22.203Z","repository":{"id":94936561,"uuid":"93173861","full_name":"LucyBot-Inc/embed-sample","owner":"LucyBot-Inc","description":"Learn how to embed LucyBot components in an existing website","archived":false,"fork":false,"pushed_at":"2017-06-05T18:48:47.000Z","size":29,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-23T14:15:17.531Z","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/LucyBot-Inc.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":"2017-06-02T14:29:22.000Z","updated_at":"2017-06-05T19:20:06.000Z","dependencies_parsed_at":"2023-06-04T17:45:53.630Z","dependency_job_id":null,"html_url":"https://github.com/LucyBot-Inc/embed-sample","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LucyBot-Inc%2Fembed-sample","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LucyBot-Inc%2Fembed-sample/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LucyBot-Inc%2Fembed-sample/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LucyBot-Inc%2Fembed-sample/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LucyBot-Inc","download_url":"https://codeload.github.com/LucyBot-Inc/embed-sample/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243971687,"owners_count":20376874,"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-23T06:31:52.492Z","updated_at":"2025-10-17T10:24:17.168Z","avatar_url":"https://github.com/LucyBot-Inc.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LucyBot Embed Sample\nLearn how to embed LucyBot components in an existing website\n\n\u003e You must have an access key for LucyBot's Documentation Generator to use this demo.\n\n## Setup\nMost of this repository contains Angular 2 boilerplate, but there are two additional steps to get LucyBot\ncomponents into your Angular app:\n\n### OpenAPI\nThe OpenAPI definition is contained in `./openapi.json`.\nIt is loaded by setting `window.lucybot.openapi.default` in ./app/openapi.js.\n\nYou can load multiple API definitions and switch between them by calling `OpenAPIService.retrieveSpec(specName)`.\n\n### Angular Module\nIn ./app/app.module.ts, we import the LucyBot module so we can reference its components, directives, pipes, and services elsewhere.\n\n```typescript\nimport * as LucyBot from 'lucybot/app/embed.module';\n\n@NgModule({\n  imports: [\n    LucyBot.EmbedModule,\n  ],\n})\n```\n\n## Usage\nThe main components are:\n* `\u003capi-call\u003e` - an API console component\n* `\u003cauth\u003e` - A modal for entering API Keys or starting OAuth flows. You can also use `SecretsService` to programatically pass credentials to LucyBot.\n* `\u003coperation-documentation\u003e` - displays parameters and responses for a given operation\n* `\u003cschema\u003e` - displays JSON schema, as well as an example JSON object\n\n./app/components/home.ts contains the logic and HTML of this demo. It shows how to use each\nof the above components, as well as the `OpenAPIService`.\n\nFor example:\n```html\n\u003cdiv class=\"box\"\u003e\n  \u003coperation-documentation [apiCall]=\"openapi.getAPICall('GET /albums')\"\u003e\u003c/operation-documentation\u003e\n\u003c/div\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucybot-inc%2Fembed-sample","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flucybot-inc%2Fembed-sample","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucybot-inc%2Fembed-sample/lists"}