create-kalix-entity

This repository provides the create-kalix-entity tool to support Kalix development with the npm/JavaScript toolchain.

Usage

This tool can be used to generate a project suitable for the general development of Kalix applications.

There are two templates available to select from:

• value-entity (default); provides the starting point to develop a Value Entity
• event-sourced-entity; provides the starting point to develop an Event Sourced Entity

To create the initial codebase for a new entity with npm:

npx @kalix-io/create-kalix-entity@latest my-entity --template value-entity
cd my-entity
npm install
npm run build

Or using Yarn:

yarn create @kalix-io/kalix-entity@latest my-entity --template value-entity
cd my-entity
yarn
yarn build

This module will be included as a dependency of the created project, providing the kalix-codegen-js tool binary for your platform.

Building

To build and test locally, first install:

npm install

...then package:

npm pack

...and then install locally (substituting with the version that the above npm pack reports):

npm install -g kalix-io-create-kalix-entity-<some-version>.tgz

As the create-kalix-entity command is now locally installed, you are able to run:

create-kalix-entity my-entity