The backend represents the Web HTTP API for the OpenHaus ecosystem.
Here are all devices/endpoints stored, messages/commands distributed and states managed.
- node.js¹ (https://nodejs.org)
- MongoDB² (https://www.mongodb.com)
The documentation is (mostly) autogenerated from the source code.
It can be found on https://docs.open-haus.io
If something missing or unclear, open a issue.
The docs folder is soon be removed.
For the HTTP API we provide a postman collection.
There exsits a public demo: http://demo.open-haus.io
It is deployed with docker and runs the frontend & backend container.
The instance is rested to its default values every 10 Minutes.
No authentication required, full API support.
We provide a postmann collection that you can import.
It containes documentation about every URL endpoint and its meaning.
Get postman on https://www.postman.com/ its great tool for HTTP testing & documentation.
If you have questions, want to contribute or just wanna have a talk, open a new issue.
Fork this repository, apply the changes you want to make, and create a pull request.
Note: If you want to contribute, please take a look on the "documentation" repository, section "How to document the source code".
Im currently not sure, under what license i publish this work.
But what i know is that, it should/must be open source and for any private/natural person free to use.
So bascily i would say:
Natural persons/private use:
Feel free to use/modify my work and do the the fck what ever you want. (As long no commercial background is involved!)
If you create something with OpenHaus (apart from normal use) give me a hint and message me.
Would be awesome to hear for what you use it.
Commercial/Distribution:
Contact me and have a talk.
You are not permitted to sell or distribute my work without my consent!
Not sure? Contact me. I would realy get in touch with you and im very flexible in terms of licensing.
¹) Install a LTS Version (At least v16)
²) Should be configured as replica set (even with only one node)