44
55Code Glue is a Home Assistant add-on that lets you create and edit entities and automations using TypeScript and Digital Alchemy from within an embedded IDE.
66
7- ## 🔧 Install (Add custom add-on repository)
7+ ## 🔧 Install
8+
9+ [ ![ Add repository on my Home Assistant] [ repository-badge ]] [ repository-url ]
810
9111 . In Home Assistant, go to: Settings → Add-ons → Add-on Store
10122 . Click the three dots (⋮) in the top-right → Repositories
11133 . Add this URL as a custom repository:
1214
13- - https://github.com/Digital-Alchemy-TS/code-glue-addon
15+ - https://github.com/Digital-Alchemy-TS/code-glue
16+
17+ 4 . Close the dialog
18+
19+ You'll now see two add-ons available:
20+
21+ ### Available Add-ons
1422
15- 4 . Close the dialog, search for "Code Glue," and open the add-on
16- 5 . Click Install, then Start
17- 6 . Optional: enable "Start on boot" and "Show in sidebar"
18- 7 . Open the add-on via the sidebar or its Web UI
19- 8 . 💰 Profit!
23+ #### Code Glue
24+ ** Stable production releases**
25+ - "Thoroughly tested"
26+ - Recommended for production use
27+ - Pulls from ` ghcr.io/digital-alchemy-ts/code-glue:latest `
28+
29+ #### Code Glue (Dev)
30+ ** Development builds for testing**
31+ - Latest features and bug fixes
32+ - May (will) be unstable and/or ugly.
33+ - Pulls from ` ghcr.io/digital-alchemy-ts/code-glue:dev `
34+ - Can run alongside production version with its own DB.
2035
2136## 🏗️ Developer Setup
2237
@@ -83,7 +98,7 @@ docker compose up -d
83986 . Migrate the database:
8499
85100``` bash
86- yarn server: db:migrate
101+ yarn workspace @code-glue/ server db:migrate
87102```
88103
891047 . Start the client and server
@@ -92,41 +107,19 @@ yarn server:db:migrate
92107yarn dev
93108```
94109
95- Access the application at ` http://localhost:8081 `
96- Access swagger: ` http://localhost:3789/swagger/ `
97-
98- ### Testing in Home Assistant
99-
100- To test the addon in a real Home Assistant environment:
101-
102- 1 . In your Home Assistant instance:
103- - Add the addon repository: ` https://github.com/Digital-Alchemy-TS/code-glue-addon `
104- - Install "Code Glue (Dev)" from the addon store
105- - This version won't conflict with the production addon
106-
107- 2 . To deploy changes:
108- ``` bash
109- # Make your changes and commit them
110- git commit -am " Your changes"
111- git push
112- # GitHub Actions will build and push to ghcr.io/digital-alchemy-ts/code-glue:dev
113- # Restart the addon in HA to pull the new image
114- ```
115-
116- The dev addon:
117- - Has a different slug (` code_glue_dev ` ) so it runs alongside production
118- - Uses its own database (separate from production)
119- - Pulls from ` ghcr.io/digital-alchemy-ts/code-glue:dev `
110+ Frontend: ` http://localhost:3000 `
111+ Swagger: ` http://localhost:3789/swagger/ `
120112
121113### 🎛️ General Commands
122114
123- #### Server
124-
125- | Command | Notes |
126- | -------------------------------------------------- | ------------------------------------- |
127- | ` yarn server:start ` / ` yarn server:start:hot ` | Start the dev server |
128- | ` yarn server:lint ` / ` yarn server:lint --fix ` | Run ` eslint ` |
129- | ` yarn server:test ` / ` yarn server:test --coverage ` | Run tests |
130- | ` yarn server:build ` | Verify there is no build issues |
131- | -------------------------------------------------- | ------------------------------------- |
132- | ` yarn dev ` | Run the server and client in dev mode |
115+ | Command | Notes |
116+ | -------------- | ------------------------------------------ |
117+ | ` yarn dev ` | Start all workspaces in dev (` start ` script) |
118+ | ` yarn build ` | Build all workspaces |
119+ | ` yarn lint ` | Lint all workspaces |
120+ | ` yarn format ` | Format all workspaces |
121+ | ` yarn test ` | Run tests across workspaces |
122+ | ` yarn typecheck ` | Type check all workspaces |
123+
124+ [ repository-badge ] : https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge
125+ [ repository-url ] : https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2FDigital-Alchemy-TS%2Fcode-glue
0 commit comments