Skip to content

installation.md

Latest commit

 

History

History
80 lines (60 loc) · 3.29 KB

installation.md

File metadata and controls

80 lines (60 loc) · 3.29 KB

Installation

[Up] [Top]

Table of Content

  1. Introduction
  2. Use Git
  3. Download Release
  4. Activate the Plugin
  5. Configure the Plugin
  6. Intellij IDEA Hints

Introduction

Depending on your setup and your plans, you can integrate this project in different ways.

  • If you want to use the plugin in your project, clone or fork the repository.
  • If you do not want to use GitHub, proceed as described in Download Release.
  • If you want to contribute a new feature or a bugfix, as an external developer, you need a fork of the repository to create a Pull Request.

Use Git

Clone this repository or your fork. Make sure to use the suitable branch for your workspace version (see README). A fork is required if you plan to customize the plugin.

Continue with Activate the plugin.

Download Release

Go to Release and download the version that matches your CMCC release version. The ZIP file provides the Maven workspace of the plugin.

Activate the Plugin

The query service is a plugin for studio-server and studio-client. The deployment of plugins is described here. The plugin can be ran locally(requires running both studio-client and studio-server). The only additional configuration needed for local studio-server is described in 3.2 and 3.3. Proxy arguments will need to be configured for running locally, described in 5. These can also be passed as command line arguments In short, for a quick development roundtrip:

  1. Add the release link to plugins.json for both studio-client and studio-server.
  2. Build the workspace

    1. Run mvn clean install in the studio-server folder.

      Checkpoint: A zip file exists in studio-server/spring-boot/studio-server-app/target/plugins.

    2. Run pnpm install && pnpm -r run build in the folder studio-client.

      Checkpoint: A zip file exists in studio-client/apps/main/app/build/additional-packages.

  3. Add the following to to studio-server application.properties, note the extra property for local running:
    1. server.servlet.session.cookie.path=/
    2. Only configure this context property for local studio-server: server.servlet.context-path=/rest
    3. If running studio server locally, adjust "plugins.directories=" to the target directory
  4. Start the studio server as usual, e.g. mvn spring-boot:run
  5. Configure global/studio/jangaroo.config.js
    1. run: { proxyTargetUris: [ "http://localhost:41080", "http://localhost:41080/rest/api/plugins", "http://localhost:41080/rest", ], proxyPathSpecs: [ "/", "/rest/api/plugins", "/rest", ], },

Now the plugin is running. you can start using it via the studio sidebar menu

Intellij IDEA Hints

For the IDEA import:

  • Ignore folder ".remote-package"
  • Disable "Settings > Compiler > Clear output directory on rebuild"