Table of Contents
Gacrux is a small home automation that is based on the latest web development techniques, because of these techniques and better maintainability the complete project is splitet in Microservices.
This project you are looking at is mainly used for getting and saving new values in the database. The values can come from a RaspberryPI which reads out a temperature sensor.
Currently the whole project is work in progress! Because of that the other services aren´t documented, tested and so on. This will change in the next weeks.
Features of Gacrux
- Latest Web and Server techniques
- Easy to use and RESTful API
- Fully Unit tested
- Free and Open Source
- Developed with <3
The beginning of this project was in the school where we had the order to create a small project with a Arduino. Because I always wanted to write my own house automation I took this as a opportunity to make it happen.
Since then I the project grows and most of my free time (mostly after work) I work on this project.
Please folow these steps:
- Make sure Redis, InfluxDB and optional a MQTT Server like Mosquitto are installed, because this project is build with docekr I recommend to use docker
- Now make sure that the configs are right, per default the application uses the default ports
npm installto install all needed dependencies
- After that you can start the server by tipping
To run the tests please follow the instructions:
- Make sure Redis is running
- Make sure InfluxDB is running
- (Optional) for a coverage report run
npm run istanbul.cover
For the API Endpoints please see: API description
The MIT License (MIT)
Copyright (c) 2015 KapuzenSohn
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.