Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 3.39 KB

installation.md

File metadata and controls

72 lines (48 loc) · 3.39 KB
Raw

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 YouTube contenthub adapter is a plugin for studio-server and studio-client. The deployment of plugins is described here.

In short, for a quick development roundtrip:

  1. Build your Blueprint.
  2. Build the content-hub-adapter-youtube

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

      Checkpoint: A zip file exists in studio-server/target.

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

      Checkpoint: A zip file exists in studio-client/apps/main/content-hub-adapter-youtube/build.

    3. Create a directory for studio-server plugins, e.g. /tmp/studio-server-plugins, and copy content-hub-adapter-youtube/studio-server/target/studio-server.content-hub-adapter-youtube-<version>.zip into that directory.

  3. Start the studio server as usual, e.g. mvn spring-boot:run, with an additional property -Dplugins.directory=/tmp/studio-server-plugins
  4. Start the studio client with an additional property -DadditionalPackagesDirs=/.../content-hub-adapter-youtube/studio-client/target/app

Now the plugin is running. You won't yet notice it though, until you configure a connection and restart the studio server.

Configure the Plugin

Once having activated the plugin as described above, you can establish the connection to the external system by adding a Settings content to the site, globally, or the user's home folder. The general Content Hub configuration is described in the Studio Developer Manual. Additional adapter-specific configuration is shown in the screenshot below:

Image1: Adapter-specific configuration

Intellij IDEA Hints

For the IDEA import:

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