Skip to content

Open-source Back-end, self-hostable & ready to use - Real-time, storage, advanced search - Web, Apps, Mobile, IoT -

License

Notifications You must be signed in to change notification settings

kuzzleio/kuzzle

This branch is 5 commits ahead of, 24 commits behind master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

efa64f8 Β· Feb 13, 2025
Jan 6, 2025
Jan 7, 2025
Jan 8, 2025
Oct 19, 2023
Feb 13, 2025
Jan 8, 2025
Jan 6, 2025
Feb 5, 2025
Oct 1, 2024
Feb 13, 2025
Nov 29, 2023
Jun 28, 2018
Jun 7, 2017
Feb 5, 2025
Nov 20, 2023
Dec 21, 2023
Dec 21, 2023
Jun 26, 2020
Aug 28, 2024
Oct 31, 2024
Oct 7, 2024
Jan 7, 2025
Jul 21, 2020
Mar 28, 2018
Mar 12, 2024
Jan 16, 2025
Oct 31, 2024
Jun 28, 2018
Sep 26, 2024
Aug 21, 2015
Jan 8, 2025
Jan 8, 2021
Apr 2, 2021
Jan 6, 2025
Jan 6, 2025
Aug 28, 2024
Jan 24, 2023
Jan 16, 2025
Jan 16, 2025
Jan 7, 2025

Repository files navigation

GitHub branch checks state Sonarcloud undefined

Why Kuzzle ?

Kuzzle is a generic backend offering the basic building blocks common to every application.

Rather than developing the same standard features over and over again each time you create a new application, Kuzzle proposes them off the shelf, allowing you to focus on building high-level, high-value business functionalities.

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

  • API First: use a standardised multi-protocol API.
  • Persisted Data: store your data and perform advanced searches on it.
  • Realtime Notifications: use the pub/sub system or subscribe to database notifications.
  • User Management: login, logout and security rules are no more a burden.
  • Extensible: develop advanced business feature directly with the integrated framework.
  • Client SDKs: use our SDKs to accelerate the frontend development.

Learn how Kuzzle will accelerate your developments πŸ‘‰ https://docs.kuzzle.io/core/2/guides/introduction/what-is-kuzzle/

Kuzzle in production

Kuzzle is production-proof, and can be deployed anywhere.

With Kuzzle, it is possible to deploy applications that can serve tens of thousands of users with very good performances.

Check out our support plans.

Run Kuzzle

The easiest way to start a Kuzzle application is to use Kourou:

kourou app:scaffold playground

 πŸš€ Kourou - Scaffolds a new Kuzzle application

generic
  βœ” Checking destination
  βœ” Prepare temporary folder
  βœ” Cloning template repository
  βœ” Copying template files
  βœ” Cleaning up

 [βœ”] Scaffolding complete!
 [βœ”] Use cd playground && docker compose up -d to start your Kuzzle stack.

Then you need to run Kuzzle services, Elasticsearch and Redis: kourou app:start-services

Finally you can run your application inside Docker with npm run docker:dev

Kuzzle is now listening for requests on the port 7512!

Use the framework

Your first Kuzzle application is inside the app.ts file.

For example, you can add a new API Controller:

import { Backend } from 'kuzzle';

const app = new Backend('playground');

app.controller.register('greeting', {
  actions: {
    sayHello: {
      handler: async request => `Hello, ${request.input.args.name}`
    }
  }
});

app.start()
  .then(() => {
    app.log.info('Application started');
  })
  .catch(console.error);

Now try to call your new API action by:

Learn how to Write an Application.

Useful links

Get trained by the creators of Kuzzle ⚑

Train yourself and your teams to use Kuzzle to maximize its potential and accelerate the development of your projects. Our teams will be able to meet your needs in terms of expertise and multi-technology support for IoT, mobile/web, backend/frontend, devops. :point_right: Get a quote

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

License

Kuzzle is published under Apache 2 License.