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

Corteza Vue

The corteza-vue package provides the common Vue-specific logic that should be accessible by any Vue-based web application.

The most common use cases for the corteza-vue package include the authentication and the API client plugins.

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

Development setup

Fork the corteza-vue repository

Core contributors should skip this part.

  1. go to the https://github.com/cortezaproject/corteza-vue 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-vue.git command

Assure dependencies

When using modified versions of the corteza-js, make sure to link it using yarn link @cortezaproject/corteza-js.

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

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 using the yarn link @cortezaproject/corteza-vue command.