Skip to content

OpenHausIO/admin-frontend

Repository files navigation

vue-project

This template should help get you started developing with Vue 3 in Vite.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Customize configuration

See Vite Configuration Reference.

Project Setup

NOTE: You need to run the backend to develop the frontend E.g. as Docker Container or application on the host machine

npm install

Create Admin account

curl -v -X PUT --unix-socket /tmp/open-haus.sock \
   http://127.0.0.1:8080/api/users \
   -H "Content-Type: application/json" \
   -d '{"email":"[email protected]","password":"Pa$$w0rd", "name":"Administrator", "enabled": "true", "admin": "true"}'

Compile and Hot-Reload for Development

npm run dev

Compile and Minify for Production

npm run build

Docker

Environment variables

Name Default value Description
NODE_ENV production node.js environment
NGINX_PORT 3001 nginx http port
NGINX_HOSTNAME open-haus.lan, open-haus.local nginx hostname
BACKEND_PROTOCOL http OpenHaus backend http protocol
BACKEND_HOST 127.0.0.1 OpenHaus backend http host
BACKEND_PORT 8080 OpenHaus backend http port
RESOLVER 127.0.0.11 DNS resolver used inside the backend location block.

Build

npm run build:docker

Export the Image

docker save openhaus/admin-frontend:latest | gzip > ./admin-frontend-vX.X.X-docker.tgz

Start a container

docker run --net=host --name=admin-frontend openhaus/admin-frontend:latest

The host network is neede when you run the backend on the docker host itself.
If you use the backend in a container or the "Quick-Start" docker example, its not needed.

Description

This is a User Interface for the HTTP backend API.
Its basicly a GUI for the postman collection.

The "Admin frontend" is a early work in progress project, that doesn't get the love it needs. Use Postman with the collection instead to access the full functionality.

Screenshots

Dashboard

Rooms

Devices

Endpoints

Plugins

Plugins

Users

Vault

SSDP

About

Administration Frontend

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published