A backend software, self-hostable and ready to use to power modern apps
If you are running Docker and just want to get your own Kuzzle running, you can use the provided docker-compose file.
Prerequisites:
- Docker (version >1.10.0)
- Docker Compose (version >1.8.0)
From Kuzzle's build repo:
$ sudo sysctl -w vm.max_map_count=262144
$ wget http://kuzzle.io/docker-compose.yml
$ docker-compose up
Check our complete installation guide here
To use Kuzzle, all you have to do is to download one of our SDKs and use it in your application. Simple as that!
Check our complete SDK Reference for further informations.
You can also interface with Kuzzle directly, using its exposed API
Because functional tests need a running Kuzzle environment, if you're using docker to run Kuzzle, then they can only be started from inside a Kuzzle container.
$ docker exec -ti <kuzzle docker image> npm test
A docker-compose script is available to run tests on a non-running Kuzzle. This script will pop a Kuzzle stack using Docker, automatically run tests, and exit once done.
$ docker-compose -f docker-compose/test.yml up
From the Kuzzle source directory, launch the following command line:
$ npm test
You're welcome to contribute to Kuzzle! To do so:
- fork our Kuzzle repository and install default plugins:
$ git submodule init
$ git submodule update
- Check our contributing documentation to know about our coding and pull requests rules
Kuzzle is published under Apache 2 License.
