@hubhazard/core v0.1.4

Table of Contents

• About the Project
• Getting Started
• Roadmap
• Contributing
• License
• Contact

About The Project

HubHazard is a simple home-automation server that allows you to easily write automations using Typescirpt. It's targeted towards people with basic programming skills. You don't have to be a professional developer to use it effectively.

When using HubHazard our automations can be as simple as a button toggling a light or as complex as an automated co-op escape room controller. You could even integrate an AI to help you control your house. All you need is a device that supports Node.js 10+, for example a \$5 Raspberry Pi Zero W.

The HubHazard server integrates with Hubitat Elevation hub!

Documentation

The project documentation is available in for of a wiki at https://github.com/hubhazard/core/wiki/.

Built With

• Node.js
• Nest.js
• Typescript

Getting Started

1. Create a new project:
   • Using the template
   • From scratch
2. Your first automation
3. Setup Hubitat integration

Roadmap

See a list of open issues with the task label.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Find an existing issue or create a new one
2. Tell us (in the issue) that you're working on it
3. Fork the project
4. Create your feature branch (git checkout -b feature/AmazingFeature)
5. Check if code is safe and readable.

• Ensure there are enough tests the test suite passes. (npm run test)
• Make sure your code is well formatted. (npm run format)
• Make sure your code is well formatted and lints. (npm run lint)
• Update the documentation
• Update changelog (CHANGELOG.md)

6. Commit your changes. (git commit -m 'Add some AmazingFeature')
7. Push to the branch. (git push origin feature/AmazingFeature)
8. Open a pull request.

See CONTRIBUTING.md from more information.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Beniamin (Xkonti) Dudek - @xkonti - online.xkonti@gmail.com

Project Link: https://github.com/hubhazard/core