For UI and linked objects developers, Kuzzle is an open-source solution that handles all the data management (CRUD, real-time storage, search, high-level features, etc;).
Kuzzle features are accessible through a secured API. It can be used through a large choice of protocols such as HTTP, Websocket or MQTT.
Using the all-in-one Docker recipe
If you are running Docker and just want to get your own Kuzzle running, you can use the provided docker-compose file.
From Kuzzle's build repo:
$ wget https://raw.githubusercontent.com/kuzzleio/kuzzle-build/master/docker-compose/kuzzle-docker-compose.yml $ docker-compose -f kuzzle-docker-compose.yml up
If you are not running Docker on your system, you can pop a virtual machine to run Kuzzle.
From the root directory:
$ vagrant up
Take a look at the documentationfor more installation ways. (Manual installation, update, add fixture, database reset and more):
Your applications can now connect to Kuzzle. We provide a few ways to do this:
- Directly, by accessing one of our API (HTTP, WebSocket and MQTT)
You can also play with our demos for a quick Kuzzle overview.
$ npm test
Because functional tests need to be done in a running Kuzzle environment, it is recommended to run these tests from a Kuzzle container.
$ docker-compose -f docker-compose/test.yml up
This command will pop all the stack for running Kuzzle, then execute unit test and functional test. When all tests are done, containers are destroyed.
Using a Vagrant virtual machine:
$ vagrant ssh -c 'cp -fR /vagrant /tmp/ && cd /tmp/vagrant && docker-compose -p kuzzle -f docker-compose/test.yml up'
Contributing to Kuzzle
Thanks to Sails project for a good Node.js infrastructure example.
Kuzzle is published under Apache 2 License.