{"id":18074515,"url":"https://github.com/codehearts/light-bubble","last_synced_at":"2025-04-05T18:46:03.611Z","repository":{"id":37050004,"uuid":"146955292","full_name":"codehearts/light-bubble","owner":"codehearts","description":"🏮 A little project to control my bedroom lighting without invasive apps","archived":false,"fork":false,"pushed_at":"2025-04-04T23:22:00.000Z","size":783,"stargazers_count":0,"open_issues_count":8,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-05T00:26:04.077Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/codehearts.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","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}},"created_at":"2018-09-01T00:48:44.000Z","updated_at":"2022-01-11T02:03:07.000Z","dependencies_parsed_at":"2023-02-19T17:55:17.456Z","dependency_job_id":"c20deb99-d7e2-4c37-a823-da0662f1ec63","html_url":"https://github.com/codehearts/light-bubble","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codehearts%2Flight-bubble","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codehearts%2Flight-bubble/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codehearts%2Flight-bubble/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codehearts%2Flight-bubble/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codehearts","download_url":"https://codeload.github.com/codehearts/light-bubble/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247385683,"owners_count":20930599,"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":[],"created_at":"2024-10-31T10:13:21.310Z","updated_at":"2025-04-05T18:46:03.588Z","avatar_url":"https://github.com/codehearts.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# light-bubble\n\nA little project to control my bedroom lighting without invasive apps.\n\n[![Build Status][build-badge]][build-link] [![Coverage][coverage-badge]][coverage-link]\n\n## Configuration\n\nConfiguration is done via `config.json`. This repo includes a `config-sample.json` file which you can reference to start your own config. Available configurations are listed below:\n\n- `port (int)`: Port for the light-bubble server to run on\n- `host (str)`: Host for the light-bubble server to listen on\n- `theme (str)`: Your preferred interface for light-bubble. Available themes are:\n  - default: A plain and understated theme\n  - horizon: Heavily inspired by a slice-of-life game I can't play yet\n- `devices (arr of devices)`: Configurations for individual devices, in order of appearance on the interface\n\nSupported devices and their configurations are listed below\n\n### Tuya Outlet Configuration\n\n- `make (str)`: `\"tuya\"`\n- `model (str)`: `\"outlet\"`\n- `config (obj)`: Configuration for the Tuya outlet\n  - `id (str)`: Unique ID for the device\n  - `key (str)`: API key for the device\n  - `ip (str)`: IP address of the device\n- `title (str)`: Your name for the device\n- `fields (arr of str)`: Your labels for each outlet on the device\n\n## Local Setup\n\nOnce your configuration is set, you can start light-bubble on your configured port as follows:\n\n```sh\nnpm start\n```\n\n## Docker Setup\n\nFirst, move `config-sample.json` to `config.json` and configure as needed. Build the container, then run it on port 49160 (or whatever port you want):\n\n```\ndocker build -t light-bubble .\ndocker run -p 49160:8080 -d light-bubble\n```\n\n## Themeing\n\nlight-bubble can be themed by creating the following files:\n\n- `static/theme-${theme_name}/`\n  - `style.css`: stylesheet for the theme\n  - `icon.png`: a 192x192px png for the theme's app icon\n  - `manifest.webmanifest`: a webmanifest customized for the theme\n\nSimply set the `theme` field in your `config.json` to the name of your theme, and you're done!\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/codehearts/light-bubble/master\n[coverage-link]:  https://codecov.io/gh/codehearts/light-bubble\n[build-badge]:    https://img.shields.io/github/workflow/status/codehearts/light-bubble/Test/master\n[build-link]:     https://github.com/codehearts/light-bubble/actions?query=workflow%3ATest+branch%3Amaster\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodehearts%2Flight-bubble","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodehearts%2Flight-bubble","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodehearts%2Flight-bubble/lists"}