dangreco / ha-card-workbench

Web IDE for testing during the development of Home Assistant custom cards.

Home Assistant Card Workbench

Faster and more intuitive development & testing for Home Assistant custom cards.

Live Site

Report Bug · Request Feature

About The Project

I couldn't find a nice way of playing around with state values while being able to live refresh the card while working on custom Home Assistant cards. This workbench is a solution to both of those problems.

If you like this project, consider buying me a coffee!

Built With

• Preact
• Zustand
• home-assistant-js-websocket
• dayjs
• js-yaml
• react-json-tree
• @uiw/react-codemirror

Getting Started

Online Workbench

Go to the live workbench.

Disable protection for the site (otherwise it won't be able to load the card script):

Local Workbench

Clone the repository:

$ git clone https://github.com/dangreco/ha-card-workbench && cd ha-card-workbench

Install dependencies:

$ yarn install

Start server:

$ yarn dev

Features/Usage

Entities Editor/Viewer

Entities

This editor is for modifying/viewing entity states. Disconnected from HASS, you can write and read mock values. If you are connected to HASS, the view will change to a JSON tree in read-only mode. (If you want to modify your HASS values, simply disconnect from HASS, and the workbench will remember all the entity states.)

Connection

In the top right corner there is a button to enable a connection to your HASS server for real-time entity access.

Card Config Editor

This editing window lets you edit your card's configuration in the same way that you would normally.

Workbench Config

This panel allows you to set the location of your card's JS file. If you are on the online workbench and this is not working, please see above on disabling site protection.

There are two "Name" inputs: one for the card's element name (e.g. threedy-card) and the other for the configuration carc's element name (e.g. threedy-config-card).

Roadmap

See the open issues for a list of proposed features (and known issues).

• Allow emulation/usage of Home Assistant events & services
• Implement native Lovelace Cards
• Visual/Code config editor switch

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.