@amag-ch/cds-launchpad


Lauchpad Sandbox for local testing

Table of Contents

- Installing
- Usage
- Configuration
- License

Installing

Using npm:

``bash
$ npm install @amag-ch/cds-launchpad --save-dev
`

Using yarn:

`bash
$ yarn add @amag-ch/cds-launchpad --dev
`

Usage

Before cds version 6.8.0, add following to your custom server.js:

`js
if (process.env.NODE_ENV !== 'production') {
cds.once('bootstrap', () => new (require('@amag-ch/cds-launchpad'))())
}
`

or the long version

`js
if (process.env.NODE_ENV !== 'production') {
const Lauchpad = require('@amag-ch/cds-launchpad')
cds.once('bootstrap', () => new Lauchpad())
}
`
Since cds version 6.8.0 the cds plugin feature register the launchpad automatically


Afterthen the launchpad is available under http://localhost:4004/$launchpad

Applications which should be displayed must be defined in package.json of your project under sapux

`jsonc
{
"sapux": [
"app/application1",
"app/application2"
]
}
`

Configuration

$3

Call new Lauchpad({...}) constructor to change the default options
`jsonc
{
path: '/$launchpad', // Path under which the launchpad serves
name: 'Launchpad', // Name of the lauchpad
title: 'Lauchpad Sandbox', // Title of the launchpad
cdn: 'https://ui5.sap.com', // URL from where the libs should be loaded
version: '', // Specific UI5 version
libs: 'sap.ui.core, sap.m, sap.ushell, sap.fe.templates', // UI5 libraries should be loaded at startup
theme: 'sap_horizon' // UI5 theme
}
`

$3

Add launchpad configuration in package.json or .cdsrc.json

`jsonc
{
"cds": {
"launchpad": {
"version": "1.115.1",
"theme": "sap_horizon_dark"
}
}
}
`

$3

If the project have multipe tiles, it's possible to move them in own groups

`jsonc
{
"cds": {
"launchpad": {
"groups": {
"business": [
"app/application1"
],
"technical": [
"app/application2"
]
}
}
}
}
`

$3

If auto generated groups titles doesn't fit, then those can be set manually

`jsonc
{
"cds": {
"launchpad": {
"titles": {
"groups": {
"business" "Different title for business"
}
},
"groups": {
"business": [
"app/application1"
],
"technical": [
"app/application2"
]
}
}
}
}
`

$3

If the project have multipe tiles, it's possible to move them in own catalogs

`jsonc
{
"cds": {
"launchpad": {
"catalogs": {
"technical": [
"app/application2"
]
}
}
}
}
`

$3

If auto generated catalogs titles doesn't fit, then those can be set manually

`jsonc
{
"cds": {
"launchpad": {
"titles": {
"catalogs": {
"technical" "Different title for technical"
}
},
"catalogs": {
"technical": [
"app/application2"
]
}
}
}
}
`

$3

If tiles / applications should be only add, if logined user have the corresponding rights, then roles and assignment must be defined.

If an application is not assigned to a role, then it's general accessable.

It's only working if cds.middlewares are active.

`jsonc
{
"cds": {
"launchpad": {
"titles": {
"groups": {
"business" "Different title for business"
}
},
"roles": {
"BusinessUser": [
"app/application1"
],
"TechnicalUser": [
"app/application2"
]
},
"groups": {
"business": [
"app/application1"
],
"technical": [
"app/application2"
]
}
}
}
}
`

$3

If applications should be started only over target navigation, then those can be added to special hidden catalog and group.

`jsonc
{
"cds": {
"launchpad": {
"catalogs": {
"business": [
"app/application1"
],
"hidden": [
"app/application2"
]
},
"groups": {
"business": [
"app/application1"
],
"hidden": [
"app/application2"
]
}
}
}
}
``

License

MIT