AndreKoepke / home-system

A smart-home system
0 stars 0 forks source link

home-system Dynamic JSON Badge

Smart homes are rising. But often, a home with programmable switches is called "smart".
I think, that a home reaches "smartness", when you only have to touch a button rarely.
This is, what this project is trying to do.

Feature list

Impressions

https://user-images.githubusercontent.com/15613049/180959741-51ba3127-e8d8-4695-98f8-1470ca409d50.mp4

https://user-images.githubusercontent.com/15613049/182154112-0151bb8e-9f1e-4a9d-a596-d0e1fca3b3e1.mp4

Installation

Currently there is no user-friendly setup. See this issue.

Prerequisite

Helm with kubernetes (preferred)

git clone git@github.com:AndreKoepke/home-system.git
cd home-system
mv helm/config/applications.yaml.example helm/config/applications.yaml
nano helm/config/applications.yaml
helm upgrade --install yourHome helm/

Pure docker

You can also start the docker-image directly. In that case, you have to mount the application.yaml directly.

git clone git@github.com:AndreKoepke/home-system.git
cd home-system
mv helm/config/applications.yaml.example helm/config/applications.yaml
nano helm/config/applications.yaml
docker run -p 8080:8080 -v $(pwd)/helm/config:/app/resources/ akop/home-system

For telegram-webhook: Ensure, that your container can be reached from the internet and behind a reverse-proxy with a TLS-certificate.


Some words about quality

I'm working alone on this project, and I haven't much time for tests.

Don't judge me for bugs. :) ![Meme for testing in production](docs/ressources/test_in_production.png)