New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

NPM skeleton #42

Open

kavilla opened this issue Mar 9, 2023 · 0 comments · May be fixed by #47

Assignees

Labels

Member

kavilla commented Mar 9, 2023 •

edited

Loading

Setup SDK to be prepared to build and publish itself to NPM.

Requirements:

Basic interface exported
Builds out code
Can be installed via direct file path
Can be published to NPM

kavilla added the enhancement label

kavilla self-assigned this

kavilla added a commit to kavilla/opensearch-dashboards-sdk-js that referenced this issue


          Initial commit with client

7b20940

Defining and exporting types `application` and `mount` to be utilized
and implemented.

Published with
```
npm publish --access public
```

Example publish:
https://www.npmjs.com/package/@avillk/opensearch-dashboards-sdk

Example of working solution of consuming the SDK:
https://github.com/kavilla/OpenSearch-Dashboards-1/tree/avillk/consume-sdk-2

Generate docs with the following:
```
yarn gen:doc
```

Issue Resolved:
opensearch-project#42

Signed-off-by: Kawika Avilla <[email protected]>

kavilla linked a pull request

that will close this issue

Initial commit with client #47

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment