https://github.com/bettyblocks/component-sdk

https://github.com/bettyblocks/component-sdk

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/bettyblocks/component-sdk
• Owner: bettyblocks
• Created: 2022-01-20T08:29:53.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-25T09:20:12.000Z (6 months ago)
• Last Synced: 2024-10-10T22:35:01.282Z (3 months ago)
• Language: TypeScript
• Size: 3.7 MB
• Stars: 0
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Betty Component SDK

A collection of APIs to develop on the Betty Blocks platform

## Documentation

[API docs](https://bettyblocks.github.io/component-sdk/modules.html)

[Guides](https://github.com/bettyblocks/cli/wiki/Components:Prefabs-(Experimental))

Generate documentation locally:

```bash

    yarn build:docs

```

## Installation

Install the sdk with npm:

```bash

  npm install @betty-blocks/component-sdk --also=dev

```

Install the sdk with yarn:

```bash

  yarn add -D @betty-blocks/component-sdk

```

## Running Tests

To run tests, run the following command:

```bash

  yarn test

```

## Development Notes

Please add unit tests for all new functionality.

You can use yarn link to test this package locally to make sure

it performs as expected.