{"id":21260299,"url":"https://github.com/digital-alchemy-ts/haos-template","last_synced_at":"2025-07-11T03:31:05.399Z","repository":{"id":222890143,"uuid":"758625074","full_name":"Digital-Alchemy-TS/haos-template","owner":"Digital-Alchemy-TS","description":"Streamline Home Assistant automation with TypeScript! 🚀 Automatic type definitions, minimal dependencies, and VSCode optimized. Get started easily! 🏡💡","archived":false,"fork":false,"pushed_at":"2025-05-11T21:06:39.000Z","size":31409,"stargazers_count":16,"open_issues_count":5,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-11T22:19:23.815Z","etag":null,"topics":["automation","beginner","digital-alchemy","home-assistant","home-automation","quickstart","starter-project","template","typescript"],"latest_commit_sha":null,"homepage":"https://docs.digital-alchemy.app","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Digital-Alchemy-TS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"zoe-codez","patreon":null,"open_collective":null,"ko_fi":"zoe_codez","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2024-02-16T18:06:56.000Z","updated_at":"2025-05-11T21:06:42.000Z","dependencies_parsed_at":"2024-08-13T03:56:58.408Z","dependency_job_id":"347bc2be-4a2a-4d07-b19a-729062407b27","html_url":"https://github.com/Digital-Alchemy-TS/haos-template","commit_stats":null,"previous_names":["zoe-codez/automation-template","zoe-codez/automation-quickstart","digital-alchemy-ts/automation-quickstart","digital-alchemy-ts/haos-template"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Digital-Alchemy-TS/haos-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Digital-Alchemy-TS%2Fhaos-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Digital-Alchemy-TS%2Fhaos-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Digital-Alchemy-TS%2Fhaos-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Digital-Alchemy-TS%2Fhaos-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Digital-Alchemy-TS","download_url":"https://codeload.github.com/Digital-Alchemy-TS/haos-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Digital-Alchemy-TS%2Fhaos-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264721297,"owners_count":23653915,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","beginner","digital-alchemy","home-assistant","home-automation","quickstart","starter-project","template","typescript"],"created_at":"2024-11-21T04:17:31.961Z","updated_at":"2025-07-11T03:31:05.392Z","avatar_url":"https://github.com/Digital-Alchemy-TS.png","language":"Shell","funding_links":["https://github.com/sponsors/zoe-codez","https://ko-fi.com/zoe_codez"],"categories":[],"sub_categories":[],"readme":"# HAOS Template Repo 🏡💻\n\nWelcome to the Digital Alchemy Starter Repo!\n\nThis repository is designed to work with **Supervised** and **HAOS** based installs, where **Addons** are supported. See [installation documentation](https://www.home-assistant.io/installation/#advanced-installation-methods) for a comparison of different installation types. These instructions assume that [Studio Code Server Addon](https://github.com/hassio-addons/addon-vscode) has been installed, serving as both editor and workspace management tool.\n\n- 🗣️ [Discord](https://discord.gg/JkZ35Gv97Y)\n- 📖 Extended [documentation](https://docs.digital-alchemy.app/docs/home-automation/quickstart)\n- 🤖 [Next steps](https://docs.digital-alchemy.app/docs/home-automation/quickstart/haos-template/next-steps) for using workspace\n\n## 🚀 Setup\n\nWithin the **Code Server Addon**:\n\n1. **Open a terminal**\n\n\u003e Press **Ctrl-Shift-\\`** (default keybind) to open a terminal, or go through `Menu` \u003e `Terminal` \u003e `New Terminal`.\n\n2. **Execute the command**\n\n```bash\ncurl -fsSL https://setup.digital-alchemy.app -o setup.sh; bash setup.sh\n```\n\nThis command will:\n\n- Download [setup script](./scripts/setup.sh) \u0026 run it\n- Install NodeJS on your system\n- Clone this repository\n- Set up type definitions\n- Provide next steps\n\n## ⚒️ Workspace Management\n\nIn order to help **Code Server** to keep `node` installed, you need to add a the following script as an `init_command` in the **Configuration** tab.\n\n```bash\n/config/home_automation/scripts/init.sh\n```\n\n![ui location](https://docs.digital-alchemy.app/assets/images/init_command-006a565b7b07725ae1916391b89b10ae.png)\n\n### Build Types\n\nUse the type writer script to build custom definitions for your **Home Assistant** instance.\nThese are written to a `src/hass` folder by default.\n\n```bash\nyarn type-writer\n```\n\n## 💻 Commands\n\nOnce your environment is set up, you can use provided commands from within the `package.json` to manage your workspace.\n\n| NPM Command | Description |\n| ---- | ---- |\n| **`upgrade`** | ⏺️ Upgrade all `@digital-alchemy` dependencies\u003cbr\u003e**Automatically runs `type-writer` afterwards** |\n| **`dev`** | ⏩ Run the development server\u003cbr\u003e**Not intended for long term deployments!** |\n| **`watch`** | 👀 Run the development server\u003cbr\u003e**Automatically restart server on code changes** |\n| **`build`** | 🏗️ Create a build of your code in the `/share/digital_alchemy/` folder\u003cbr\u003e**Addon has been set up to run from here** |\n| **`type-writer`** | 🖨️ Rebuild custom type definitions for Home Assistant\u003cbr\u003e**Run any time you modify your setup for more accurate definitions** |\n\n## 🧰 Extra Tools\n\n- [Code Runner Addon](https://github.com/Digital-Alchemy-TS/addons/) - Create builds and run in the background\n- [Synapse Extension](https://github.com/Digital-Alchemy-TS/synapse-extension/) - Generate helper entities within Home Assistant\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigital-alchemy-ts%2Fhaos-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdigital-alchemy-ts%2Fhaos-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigital-alchemy-ts%2Fhaos-template/lists"}