Quick Start

Installation

To get started with the yuuvis® MOMENTUM client, you need to have Node.js v18 or newer installed on your machine. It is recommended to use the yuuvis® client CLI for setting up and developing yuuvis® MOMENTUM client projects. This tool was specifically developed to streamline and simplify the development process for yuuvis® MOMENTUM clients.

The yuuvis client CLI leverages Angular Schematics to scaffold new client projects, ensuring a familiar and robust foundation for Angular developers. In addition to standard project setup, the CLI automates the generation and configuration of all resources required for yuuvis® MOMENTUM client projects. This includes project structure, recommended dependencies, configuration files, and best-practice defaults tailored specifically for the yuuvis® MOMENTUM ecosystem. By using the CLI, developers can quickly bootstrap new projects with all necessary settings and integrations, reducing manual effort and ensuring consistency across different client implementations.

You can install the CLI globally using npm:

npm install -g @yuuvis/client-cli

Creating a new client project

Create an new yuuvis® MOMENTUM client project using the new command of the CLI:

yuv new myclient

The new command will prompt you to select a shell version which will be initially used for your project. You can choose between the latest stable release or a specific version if needed. After selecting the shell version, the CLI will generate a new Angular workspace with a pre-configured yuuvis® MOMENTUM client application. At the end of the setup process, all required dependencies will be installed automatically. Once the setup is complete, you can navigate into the generated workspace and explore the project structure.

cd myclient

You can use any IDE or code editor of your choice to work with the generated project. For the best development experience, Visual Studio Code (VS Code) is recommended.

Starting the client application

To start the development server and run your yuuvis® MOMENTUM client application locally, use the following command:

npm run start

Creating a new app or extension

You can create new apps or extensions using the generate command of the CLI. For example, to create a new app named “my-app”, run the following command:

yuv generate app my-app

You will be prompted to provide essential properties required for creating the app. Die neue App wird im Verzeichnis projects erstellt und enthält standardmäßig den Extension code. If you want to create an app without extension, use the --skip-extension flag:

yuv generate app my-app --skip-extension

To create a pure extension named “my-extension” (i. e., an app without GUI), generate a new app and hide it from the application bar using the --hide-from-nav flag. Keep the default application code in app’s src/lib directory:

yuv generate app my-extension --hide-from-nav

Adding (re-using) an existing app or extension

You can add existing apps or extensions to your client project using the add command. For example, to add the official document management app @yuuvis/app-drive, run the following command:

yuv add app @yuuvis/app-drive

You can add any app or extension that is published as an npm package. The CLI will install the package and automatically configure it in your client application. After adding an app or extension, you can start using it immediately in your client project.