{"id":18277478,"url":"https://github.com/standardnotes/component-relay","last_synced_at":"2025-04-05T04:30:33.862Z","repository":{"id":42671578,"uuid":"93971731","full_name":"standardnotes/component-relay","owner":"standardnotes","description":"A bridge that handles communication between Standard Notes and an external extension.","archived":false,"fork":false,"pushed_at":"2023-01-09T13:24:02.000Z","size":2240,"stargazers_count":12,"open_issues_count":6,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-31T21:36:03.479Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.standardnotes.com/extensions/components","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/standardnotes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-10T23:55:38.000Z","updated_at":"2023-08-14T17:12:50.000Z","dependencies_parsed_at":"2023-02-08T12:01:32.837Z","dependency_job_id":null,"html_url":"https://github.com/standardnotes/component-relay","commit_stats":null,"previous_names":["sn-extensions/components-api"],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/standardnotes%2Fcomponent-relay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/standardnotes%2Fcomponent-relay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/standardnotes%2Fcomponent-relay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/standardnotes%2Fcomponent-relay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/standardnotes","download_url":"https://codeload.github.com/standardnotes/component-relay/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247289382,"owners_count":20914463,"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-05T12:19:18.200Z","updated_at":"2025-04-05T04:30:33.106Z","avatar_url":"https://github.com/standardnotes.png","language":"TypeScript","readme":"# Component Relay\n\nTo get started using the Component Relay, read the [Intro to Extensions guide](https://docs.standardnotes.org/extensions/intro).\n\n## Installation\n\n```\nyarn add @standardnotes/component-relay\n```\n\n\u0026dash; _or_ \u0026dash;\n\n```\nnpm install --save @standardnotes/component-relay\n```\n\n### Manual\n\nImport the file `dist/dist.js` in your HTML file. For example:\n\n```html\n...\n\u003cscript type=\"text/javascript\" src=\"dist/dist.js\"\u003e\u003c/script\u003e\n...\n```\n\n## Tests\n\nThe `component-relay` uses [Jest](https://jestjs.io/) for tests. Tests are located in the [test](test) directory. Test files have the following name: `\u003cname\u003e.test.js`.\n\n### Run all tests\n\nRun `yarn test` or `npm test` to run all test suites.\n\n### Coverage\n\nCoverage can be generated by running the `coverage` script.\n\nThen open the [coverage/index.html](coverage/index.html) file in a browser to view it.\n\n## Documentation\n\nDocumentation is generated using [Typedoc](https://typedoc.org/). The documentation is available at https://standardnotes.github.io/component-relay/. To update the docs or to view the latest version, run:\n\n```\nyarn build:docs\n```\n\nThis will generate documentation and place it in the `docs/` directory. Create a localhost server using `http-server` and open the [docs/index.html](docs/index.html) file in a browser to view the docs.\n\nTo deploy the latest version of the docs to the `gh-pages` branch to publish using [GitHub Pages](https://pages.github.com/), replace `2.0.1` with the latest version and run:\n\n```\nyarn deploy-docs -m \"build: v2.0.1\"\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstandardnotes%2Fcomponent-relay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstandardnotes%2Fcomponent-relay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstandardnotes%2Fcomponent-relay/lists"}