myhome-presence

module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 22, 2025 License: MIT

README

myhome-presence

A web service for querying, managing and tracking home devices presence at home.

Building

Requirements:

In a shell, execute: make (or make build).

The build artifacts can be cleaned by using: make clean.

Running

In a shell, execute make run or make run-image to run from a container.

API

The API is documented using the OpenAPI specification.

The Swagger UI for consuming the API is reachable from http://localhost:8080. Note: when using the Chrome web browser, in order to get the web UI to work, one should ensure that "Insecure content" permission is allowed (Swagger UI is served via https but here the API specification is server via http).

Directories

Path Synopsis
cmd
internal
api
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL