# BAQ React SDK &middot; [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/baqhub/baq/blob/main/packages/lib-sdk-react/LICENSE) [![npm version](https://img.shields.io/npm/v/@baqhub/sdk-react.svg?color=)](https://www.npmjs.com/package/@baqhub/sdk-react)

This is the official React SDK for the [BAQ](https://baq.dev) federated app platform. It provides components and hooks to make it easier to build reactive UI on top of records.

## Installation

The BAQ React SDK is distributed as an NPM package.

```bash
npm install @baqhub/sdk @baqhub/sdk-react
```

Platform-specific features are implemented in [separate packages­](https://baq.dev/docs/reference/react-sdk/types/storageadapter#localstorageadapter).

```bash
npm install @baqhub/sdk-react-dom
```

## Documentation

- **[Getting started guide](https://baq.dev/docs/learn/guides/using-the-react-sdk)** : Overview of the React SDK.
- **[Full reference](https://baq.dev/docs/reference/react-sdk/components)** : All the components and hooks.

## License

The BAQ React SDK is [MIT licensed](https://github.com/baqhub/baq/blob/main/packages/lib-sdk-react/LICENSE).
