You are reading the documentation for an outdated Corteza release. 2024.9 is the latest stable Corteza release.

Corteza JS

The corteza-js package provides the common logic that should be accessible by any web or Node.js application.

The most common use cases for the corteza-js package include type definitions and the generated API client code.

Refer to the Corteza Core Repositories for details regarding the release process.

Development setup

Fork the corteza-js repository

Core contributors should skip this part.

  1. go to the https://github.com/cortezaproject/corteza-js repository

  2. click on the Fork button in the top right corner and follow the instructions on the screen.

Clone the repository

Using the CLI:

  1. open the CLI

  2. navigate to your working folder

  3. run the git clone git@github.com:$YOUR_USERNAME_HERE/corteza-js.git command

Refer to the repository if you wish to use an alternative method.

Assure dependencies

Run the yarn command to assure that all of the packages are present and up to date.

See the package.json file for the supported Node.js versions.

Build the bundle

Run the yarn build command to build a fresh bundle. The optional -w flag will automatically rebuild the bundle when changes occur.

Linking the package

Run the yarn link command to make this package linkable. The package can be linked by running yarn link @cortezaproject/corteza-js where needed.