Skip to content

Latest commit

 

History

History
151 lines (105 loc) · 6.37 KB

README.md

File metadata and controls

151 lines (105 loc) · 6.37 KB
Raw

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:

npx kourou app:scaffold playground

 🚀 Kourou - Scaffolds a new Kuzzle application

  ✔ Creating and rendering application files

 [✔] Scaffolding complete! Use cd playground && npm run docker npm install install dependencies and then npm run docker:dev to run your application!

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

Public Roadmap

You can consult the public roadmap on Trello. Come and vote for the features you need! :point_right: Kuzzle Public Roadmap

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 Discord
  • Ask technical questions on stack overflow
  • Check out our public roadmap and vote for the upcoming features

License

Kuzzle is published under Apache 2 License.

About Mac M1

First of all make sure that you have at least 4GB of ram allocated to your vm docker desktop and that it is running.

Run the following command to install all the dependencies in your container:

npm run docker:install

finally run the command docker-compose up to launch your kuzzle stack.