Kuzzle IoT Platform Project

This repo is a template to create a project using the Kuzzle IoT Platform, like our mantra for kuzzle, we value your time, so rather than developping your own platform, you can start from our work and add high-level, high-value business functionalities. Have a look at our documentation and how to get started.

This repo contains a pre-configured Turborepo with the necessary tooling to create a project using the IoT Platform.

Important Notes

This is a product under license that require private packages in order to work. You need to have a valid license to use it. If you don't have one, you can request a license here.

Installation and run

Requirement:

• Node.js >= 18
• NPM = 10.1.0
• Docker
• Docker-Compose

What's inside?

Turborepo

This turborepo uses npm as a package manager. It includes the following apps:

2 applications

• api: a Kuzzle IoT Backend application
• web: a Kuzzle IoT Console application

Install dependencies

Log to Kuzzle npm private repository : https://docs.kuzzle.io/paas-console/1/guides/access-private-plugins/

Go to the repository root and run npm install

Run the stack

docker compose run --rm api npm install
docker compose up -d

Useful Links

Learn more about the power of Kuzzle

• Getting Started with Kuzzle
• API
• Data Storage
• Querying
• Permissions
• Authentication
• Realtime Engine
• Discover our SDKs
• Release Notes

Learn more about the power of Turborepo:

• Pipelines
• Caching
• Remote Caching
• Filtering
• Configuration Options
• CLI Usage