Skip to content

Latest commit

 

History

History
38 lines (32 loc) · 1.71 KB

README.md

File metadata and controls

38 lines (32 loc) · 1.71 KB
Raw

Homescreen

This is a service for your personal touchscreen at home. You can display and control all your home automatization functions. We will provide some interesting modules but feel free to contribute and submit your own plugins! The homescreen provides an easily usabled plugin interface.

Requirements for compiling

  • Go to compile the backend
  • Glide to load backend dependencies
  • Node.js
  • If you are using the (old) AngularJS-Forntend:
    • Bower to load the AngularJS frontend dependencies

Quickstart

after you got the project working following the guide in "Compile it yourself", and this works without any errror, you can use the quicker way to start the backend, the module library and the Angular frontend. Just navigate into the frontend directory and run:

npm run start-all

Compile it yourself

  • go get this project
    • go get github.com/homescreenrocks/homescreen
  • load dependencies
    • glide install the backend dependencies from main directory
    • For the Angular-Frontend: npm install the frontend dependencies from core/app folder
    • For the (old) AngularJS-Frontend: bower install the frontend dependencies from core/angularjs folder
  • get the plugins you want
    • go get github.com/homescreenrocks/homescreen-plugin-example
  • compile and start the homescreen core
    • execute in the main directory: go build core/backend/app.go && ./app
  • compile and start a plugin
    • cd to the plugin: go build example/main.go && ./main http://localhost:3000

we should provide a more easy way of usage :)

Use the binaries

  • ...

Frontend requirements

  • any modern browser (Chrome, Edge, Firefox)