Content

Prerequisites

Git

For yuuvis RAD version 8.16

Node from 10.8.0 to 14.x
NPM 6.x

For yuuvis RAD version 9.16:

Node from 16.14.x
NPM from 6.18

Beginning with yuuvis RAD version 10.0:

Node 20.11.0 and newer
NPM from 6.18

When upgrading a custom client from 8.16 LTS to 9.16:

follow the Angular upgrade guide from version 11 to 15: https://update.angular.io/?v=11.0-15.0
Migrate your used 3rd party libraries to match Angular 15
Migrate your additional used old components that are based on PrimeNG to the new @yuuvis/components that you get here: https://www.npmjs.com/package/@yuuvis/components

When upgrading a custom client from 9.16 LTS to 10.0 or later:

follow the Angular upgrade guide from version 15 to 17: https://update.angular.io/?v=15.0-17.0
Migrate your used 3rd party libraries to match Angular 17

Installing yuuvis dev proxy (CLI version) ...

Install yuuvis proxy cli package by running 'npm install -g @eo-sdk/proxy'. After that you can run 'eopx -t http://<gateway_host>:<gateway_port>' in your terminal to start the dev proxy.

For details on how to use yuuvis proxy visit: @eo-sdk/proxy on npmjs.com.

... or yuuvis dev proxy App

Beside the command line proxy, we provide an app to manage development proxy configurations and provide some information about the connected backend.

You can download the application as EXE or ZIP.

Installing enaio CLI

Run 'npm install -g @eo-sdk/cli' to install the package.

Run 'eo cli' to init the CLI.

For details on how to use enaio CLI visit: @eo-sdk/cli on npmjs.com.

Creating a New Custom Client Project

CLI will clone existing boilerplate with multiple branches (examples). By default, CLI is using @eo-sdk/client@current version (latest). For @eo-sdk/client@stable version, use the tag --@stable.

eo new PROJECT_NAME --@current ( = #angular17)  // for version yuuvis RAD 8.16 LTS use --#angular11 instead of --@current
                                                // for version yuuvis RAD 9.16 LTS use --#angular15 (= master) instead of --@current
# eo new PROJECT_NAME --@stable
cd PROJECT-NAME
# to run application 
npm start

Creating a New Custom Client Project with all examples

CLI will clone the existing boilerplate and switch to the branch (current-custom-client) to access all examples. Please check other branches to see specific examples.

Remark: This example is not valid for versions yuuvis RAD 9.16 and 10.x

eo new PROJECT_NAME --@current --#current-custom-client
# eo new PROJECT_NAME --@stable --#custom-client
cd PROJECT-NAME
# to run application 
npm start

Updating a Custom Client Project

In case you want to update the library ("@eo-sdk/client") to the next current/stable version. (updates are usually available every 2 weeks)

cd PROJECT_NAME
eo update --@current
# eo update --@stable
# to install specific version
eo update --@7.10.0

Setting up a git Repository

Rename the remote origin to boilerplate, so you can use it in the future in case there are updates or new examples.

Add your own project (github | gitlab | ... ) as the origin, so you can push your commits. Then simply follow the git instructions.

git remote rename origin boilerplate
git remote add origin https://github.com/user/repo.git

Your remote should look like this:

git remote -v
# Verify new remote
origin  https://github.com/user/repo.git (fetch)
origin  https://github.com/user/repo.git (push)
boilerplate https://github.com/OPTIMALSYSTEMS/eo-sdk-boilerplate.git (fetch)
boilerplate https://github.com/OPTIMALSYSTEMS/eo-sdk-boilerplate.git (push)

yuuvis® RAD

Getting Started