briskhome Goto Github PK

Briskhome is a work-in-progress extensible open-source house monitoring and automation system for Node.js that is limited by your imagination only — a high-level abstraction over all things smart home.

Heads Up! Very thorough installation instructions are available in the documentation.

The best way to get your hands on Briskhome as quickly as possible is with Vagrant and VirtualBox. Install these tools and then Simply clone this repository and run vagrant up. Vagrant will download and configure a minimal linux image, install all the dependencies and seed your Briskhome installation with demo data.

For a real-world installation we recommend using prebuilt installation packages. We provide packages for current versions of Ubuntu, Debian and CentOS. Download them from releases page and install it with your package manager of choice.

Up-to-date documentation is available online at docs.briskhome.com and is divided into three major sections:

• Administrator Guide covers the initial server setup and configuration, installing software dependencies and deploying.
• Developer Handbook explains system APIs and teaches how to create additional Briskhome plugins.
• User Manual contains detailed usage instructions for end users.

Briskhome welcomes contributions! There are several ways you can get involved.

• Developing. Take a look at our current release roadmap or next release roadmap and feel free to jump on any tasks you like. You can see which issues are currently in progress by looking at a list of open pull requests. Also please take some time to look through the contrubution guidelines which provide a review of our development process.
• Documenting. You can help us write documentation for the latest release or preparing specifications for the new features. Or you can fork the docs and maintain a translation in your language!
• Reporting bugs. If you have encountered a bug or have experienced an unexpected behavior, please open an issue.
• Suggesting features. You can always suggest a new feature by opening an issue or getting in touch with us on Slack.

The MIT License (MIT)

Copyright (c) 2015-2017 Egor Zaitsev

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.