Open-source Back-end, self-hostable & ready to use - Real-time, storage, advanced search - Web, Apps, Mobile, IoT -
JavaScript Gherkin Other
Clone or download
Permalink
Failed to load latest commit information.
.github Merge remote-tracking branch 'origin/master' into 1.x May 16, 2018
bin Release 1.4.2 (#1166) Jul 27, 2018
docker-compose Release 1.4.0 (#1151) Jul 10, 2018
features Release 1.4.0 (#1151) Jul 10, 2018
lib [Hotfix] Fix tabulation issue for eslint Aug 7, 2018
plugins Release 1.4.0 (#1151) Jul 10, 2018
protocols Release 1.4.0 (#1151) Jul 10, 2018
run fix "No mapping found for [_kuzzle_info.deletedAt]" error at startup (#… Jun 7, 2017
test Hotfix: auth. rejection reason not forwarded to users (#1170) Aug 2, 2018
vagrant move default port to 7512 Feb 8, 2017
.dockerignore enable sonar in project Feb 20, 2017
.eslintrc.json eslint Jun 19, 2017
.gitignore Release 1.4.0 (#1151) Jul 10, 2018
.gitmodules Re-added submodules with https Jan 24, 2017
.kuzzlerc.sample Release 1.4.2 (#1166) Jul 27, 2018
.npmignore enable sonar in project Feb 20, 2017
.nycrc fix coverage issue with rewire@3 Mar 28, 2018
.travis.yml update npm api key Jul 27, 2018
CHANGELOG.md [skip ci] update compatibility matrix Jun 20, 2017
CONTRIBUTING.md Update CONTRIBUTING.md Jul 10, 2017
Dockerfile replace "npm --unsafe" with "npm --unsafe-perm" May 29, 2018
LICENSE.md Release 1.4.0 (#1151) Jul 10, 2018
README.md Dependencies update (#1102) May 2, 2018
Vagrantfile add a dockerfile and move vagrant.yml into vagrant folder Aug 21, 2015
build-docker-images.sh Release 1.4.2 (#1166) Jul 27, 2018
codecov.yml add codecov configuration file Nov 10, 2016
cucumber.js Release 1.4.0 (#1151) Jul 10, 2018
default.config.js Release 1.4.2 (#1166) Jul 27, 2018
package-lock.json Hotfix: auth. rejection reason not forwarded to users (#1170) Aug 2, 2018
package.json Hotfix: auth. rejection reason not forwarded to users (#1170) Aug 2, 2018
sonar-project.properties <insert rant here> Apr 24, 2017

README.md

Build Status codecov.io Join the chat at https://gitter.im/kuzzleio/kuzzle

logo

Why Kuzzle ?

Kuzzle is a ready-to-use, on-premises backend that enables you to manage your persistent data and be notified in real-time on whatever happens to it. It also provides you with a flexible and powerful user-management system.

Kuzzle enables you to build modern web applications and complex IoT networks in no time.

  • Persisted data: store your data and perform advanced searches on it.
  • Real-time notifications: subscribe to fine-grained subsets of data.
  • User Management: login, logout and security rules are no more a burden.
  • Extensible: fit Kuzzle to your needs by leveraging the plugin system.

Installation

Quick install

The easyest way to setup a kuzzle server for Linux-like systems without prerequisites is to download and run our installation script:

$ sudo bash -c "$(curl http://get.kuzzle.io/)"

You can get detailed information about how to start kuzzle with docker on docs.kuzzle.io

Manual install

Check our complete installation guide on docs.kuzzle.io

Quick start with Kuzzle

Check the Getting started page on docs.kuzzle.io

NodeJS Sample

npm install kuzzle-sdk
const
    Kuzzle = require('kuzzle-sdk'),
    kuzzle = new Kuzzle('http://localhost:7512')

const filter = {
    exists: {
        field: 'message'
    }
}

// Subscribe to data changes in an app
kuzzle
    .collection('mycollection', 'myindex')
    .subscribe(filter, function(error, result) {
        // triggered each time a document is updated !
        console.log('message received from kuzzle:', result)
    })

// Creating a document from another app will notify all subscribers
kuzzle
    .collection('mycollection', 'myindex')
    .createDocument(document)

Usefull links

Contributing to Kuzzle

You're welcome to contribute to Kuzzle! Feel free to report issues, ask for features or even make pull requests!

Check our contributing documentation to know about our coding and pull requests rules

Join our community

  • Follow us on twitter to get latest news
  • Register to our monthly newsletter to get highlighed news
  • Visit our blog to be informed about what we are doing
  • Come chat with us on gitter
  • Ask technical questions on stack overflow

Kuzzle Enterprise

Kuzzle Enterprise is production-proof, and provides all the business-critical features your need for your business, as the scalability, the high-availability (multi-nodes), probes for BI, diagnostic tools & professional services,

Compare editions to learn more

License

Kuzzle is published under Apache 2 License.