https://github.com/standardnotes/component-relay
A bridge that handles communication between Standard Notes and an external extension.
https://github.com/standardnotes/component-relay
Last synced: 11 months ago
JSON representation
A bridge that handles communication between Standard Notes and an external extension.
- Host: GitHub
- URL: https://github.com/standardnotes/component-relay
- Owner: standardnotes
- License: agpl-3.0
- Created: 2017-06-10T23:55:38.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-01-09T13:24:02.000Z (about 3 years ago)
- Last Synced: 2025-03-31T21:36:03.479Z (11 months ago)
- Language: TypeScript
- Homepage: https://docs.standardnotes.com/extensions/components
- Size: 2.14 MB
- Stars: 12
- Watchers: 2
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Component Relay
To get started using the Component Relay, read the [Intro to Extensions guide](https://docs.standardnotes.org/extensions/intro).
## Installation
```
yarn add @standardnotes/component-relay
```
‐ _or_ ‐
```
npm install --save @standardnotes/component-relay
```
### Manual
Import the file `dist/dist.js` in your HTML file. For example:
```html
...
...
```
## Tests
The `component-relay` uses [Jest](https://jestjs.io/) for tests. Tests are located in the [test](test) directory. Test files have the following name: `.test.js`.
### Run all tests
Run `yarn test` or `npm test` to run all test suites.
### Coverage
Coverage can be generated by running the `coverage` script.
Then open the [coverage/index.html](coverage/index.html) file in a browser to view it.
## Documentation
Documentation 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:
```
yarn build:docs
```
This 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.
To 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:
```
yarn deploy-docs -m "build: v2.0.1"
```