# 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.