# Overview

This package is designed to be a template for creating custom dashboards for Home Assistant using react.

The [@hakit/core](https://www.npmjs.com/package/@hakit/core) package provides all the core functionality to authenticate with Home Assistant to create a dynamic dashboard with React! The [@hakit/components](https://www.npmjs.com/package/@hakit/components) package houses reusable components for creating custom dashboards for Home Assistant using react.

[![npm version](https://badge.fury.io/js/@hakit%2Fcore.svg)](https://www.npmjs.com/package/@hakit/core)

If you like anything here, be sure to 🌟 [my repo!](https://github.com/shannonhochkins/ha-component-kit)

![DEMO](https://github.com/shannonhochkins/ha-component-kit/blob/master/stories/hakit-demo.gif?raw=true)

## Get Started
There's an npm create command which will setup react, Typescript, Vite & Hakit automatically for you with a terminal wizard!

```
npm create hakit@latest
```

Or, if you want to install manually:
```
  npm install @hakit/core @hakit/components
```

There's detailed [documentation](https://shannonhochkins.github.io/ha-component-kit) which should give you all the information you need to get started.

### Issues / Discusssions
If you have any issues getting this going, found any bugs or want to discuss anything, please feel free to open an issue on the [github repository](https://github.com/shannonhochkins/ha-component-kit/issues), or open up a discussion on the [github discussions](https://github.com/shannonhochkins/ha-component-kit/discussions).