Development
Everything you need to work on the frontend itself. The environment, running it, the gallery and the demo, coding guidelines, tests, and review.
These pages are for working on the frontend repository: fixing bugs, improving screens, and adding features. Building a card or panel that people install on their own does not need any of this. For that, see Custom cards and more.
The frontend is written in TypeScript with Lit, and bundled with Rspack. pnpm manages the dependencies. Tests run with Vitest and Playwright. All the commands you need are scripts in package.json, so you run them with pnpm.
- Set up the environment: with the devcontainer, or on your own machine.
- Run the frontend: against a development Home Assistant, or against one you already have.
- The gallery and the demo: work on components and dashboards without a Home Assistant at all.
- Coding guidelines: how frontend code is written, and what reviewers look for.
- Linting and tests: the checks to run before you open a pull request.
- Builds and pull requests: make a production build, and try out someone else's pull request on a real Home Assistant.
- Review and release: what happens to your pull request, and how it reaches users.
All commands and ports in one place: Commands.