https://github.com/wirenboard/homeui

Wiren Board web interface
https://github.com/wirenboard/homeui

angular react

Last synced: 21 days ago
JSON representation

Wiren Board web interface

• Host: GitHub
• URL: https://github.com/wirenboard/homeui
• Owner: wirenboard
• License: mit
• Created: 2015-04-10T12:35:53.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2026-02-10T13:00:27.000Z (about 2 months ago)
• Last Synced: 2026-02-10T13:41:44.238Z (about 2 months ago)
• Topics: angular, react
• Language: TypeScript
• Homepage: https://wirenboard.com/wiki/Wiren_Board_Web_Interface
• Size: 12.1 MB
• Stars: 23
• Watchers: 17
• Forks: 21
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# homeui

Wiren Board web interface.

## MQTT naming conventions

See into [conventions](https://github.com/wirenboard/conventions/blob/main/README.md) to understand how to organize devices and controls (what write to /meta/type for example).

## NGINX configuration

The config is stored in `/usr/share/wb-mqtt-homeui/nginx/default.conf` (do not edit this file directly).

Add your custom configuration to `/etc/nginx/includes/default.wb.d/*.conf`.

Change listen settings in `/etc/nginx/includes/default.wb.d/listen.conf`.

## Running local development

1. Navigate to the project directory: `cd ./frontend`

2. Install dependencies: `npm install`

3. Create `.env` file and set `MQTT_BROKER_URI` if your controller is running on different IP (default is 10.200.200.1)

4. Start the development server: `npm run start`

## Custom menu

One can put a JSON-file with custom menu description in `/usr/share/wb-mqtt-homeui/custom-menu`.

Items, defined in the file, will be added to left navigation panel.

The structure of the JSON-file

```jsonc

[

  {

    "id": "string",

    // Not used if id is already defined

    "url": "string",

    // Not used if id is already defined

    "title": {

      "en": "string",

      "ru": "string"

    },

    "children": [

      {

        "id": "string",

        "url": "string",

        "title": {

          "en": "string",

          "ru": "string"

        }

      }

    ]

  }

]

```