### Start an SAP Fiori Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-freestyle/expected-output/simple_no_datasource/README.md

To launch the generated SAP Fiori application, navigate to the app's root folder and execute the provided command. Ensure an active NodeJS LTS version and a compatible NPM version are installed as prerequisites.

```Shell
npm start
```

--------------------------------

### Start Development Server with CDS Watch

Source: https://github.com/sap/open-ux-tools/blob/main/packages/cf-deploy-config-sub-generator/test/fixtures/cap/README.md

Initiates the `cds watch` command to start the development server, which automatically monitors and reloads the application upon changes. This is a fundamental step for local development and can be run in a terminal or via VS Code's task runner.

```Shell
cds watch
```

--------------------------------

### Start Development Server

Source: https://github.com/sap/open-ux-tools/blob/main/packages/deploy-config-sub-generator/test/headless/expected-output/caplcapmodeonly/README.md

Execute the `cds watch` command in a new terminal to initiate the development server for your project. This command monitors changes in your project files and automatically reloads the application, facilitating rapid development and testing.

```shell
cds watch
```

--------------------------------

### Start Development Server with CDS Watch

Source: https://github.com/sap/open-ux-tools/blob/main/packages/deploy-config-sub-generator/test/headless/fixtures/test-apps/cf/capapp/README.md

This command initiates the development server and watches for changes in your project files. It is a fundamental step for local development with SAP Cloud Application Programming Model (CAP) projects.

```Shell
cds watch
```

--------------------------------

### Install Yeoman and Build Fiori Elements Generator

Source: https://github.com/sap/open-ux-tools/blob/main/examples/simple-generator/README.md

Commands to globally install the `yo` command-line tool and build the custom Fiori Elements generator project, which are necessary prerequisites before running the generator.

```shell
npm install -g yo
pnpm build
```

--------------------------------

### Start Development Server with CDS Watch

Source: https://github.com/sap/open-ux-tools/blob/main/packages/project-integrity/test/test-input/valid-fiori-project/README.md

Initiates the development server for a CAP project, automatically watching for changes in project files and restarting the server as needed. This command is essential for local development and testing.

```Shell
cds watch
```

--------------------------------

### Install @sap-ux/guided-answers-helper Package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/guided-answers-helper/README.md

Instructions for installing the @sap-ux/guided-answers-helper package using different Node.js package managers (npm, Yarn, pnpm). This package provides helper utilities for Guided Answers.

```Shell
npm install --save @sap-ux/guided-answers-helper
```

```Shell
yarn add @sap-ux/guided-answers-helper
```

```Shell
pnpm add @sap-ux/guided-answers-helper
```

--------------------------------

### Run Middleware Test Fixtures Locally

Source: https://github.com/sap/open-ux-tools/blob/main/packages/preview-middleware/test/fixtures/README.md

To set up and run the test fixtures for local debugging and manual testing of the middleware, first install the necessary dependencies, then start the application. The start script automatically builds the `preview-middleware` to ensure the latest sources are used.

```Shell
npm i
npm start
```

--------------------------------

### Starting SAP Fiori Application via NPM

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-freestyle/expected-output/simple_v4_metadata_file/README.md

These commands demonstrate how to launch the generated SAP Fiori application from its root directory. The `npm start` command runs the application with live data, while `npm run start-mock` enables running the application using mock data, useful for development and testing without a live OData service.

```Shell
npm start
```

```Shell
npm run start-mock
```

--------------------------------

### Start SAP CAP Development Server

Source: https://github.com/sap/open-ux-tools/blob/main/packages/deploy-config-sub-generator/test/headless/fixtures/test-apps/cf/caplcapmodeonly/README.md

Initiates the development server for a SAP Cloud Application Programming Model (CAP) project, enabling live reloading and local testing. This command watches for changes in project files and automatically restarts the server.

```Shell
cds watch
```

--------------------------------

### Starting the SAP Fiori Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-freestyle/expected-output/simple_eslint/README.md

To launch the generated SAP Fiori application, navigate to the app's root folder and execute this command. This requires an active NodeJS LTS version and a supported NPM version to be installed as pre-requisites.

```NPM
npm start
```

--------------------------------

### Start SAP Fiori Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-freestyle/expected-output/simple_code_assist/README.md

This command is used to start the generated SAP Fiori application. It is a standard npm script that launches the development server. Users must have an active NodeJS LTS version and a supported NPM version installed as prerequisites for successful execution.

```Shell
npm start
```

--------------------------------

### Start SAP Fiori Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/telemetry/test/tools-suite-telemetry/fixtures/fiori_elements/README_LROPv4.md

Instructions to launch the generated SAP Fiori application using the `npm start` command from the root folder.

```Shell
npm start
```

--------------------------------

### Start SAP Fiori App Locally

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/headless/lrop_v4_no_ui5_version/README.md

To launch the generated SAP Fiori application, navigate to the app's root folder and execute this command. This will start the application using the configured OData service.

```shell
npm start
```

--------------------------------

### Starting a Generated SAP Fiori Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-freestyle/expected-output/simple_typescript/README.md

This snippet provides instructions on how to launch the generated SAP Fiori application. The application was created using the SAP Fiori tools - App Generator. To start the app, navigate to the generated app's root folder and execute the provided command. Ensure you have an active NodeJS LTS version and a supported NPM version installed as prerequisites.

```Shell
npm start
```

--------------------------------

### Install @sap-ux/ui5-library-reference-writer Package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/ui5-library-reference-writer/README.md

Instructions for installing the `@sap-ux/ui5-library-reference-writer` package using different Node.js package managers.

```shell
npm install --save @sap-ux/ui5-library-reference-writer
```

```shell
yarn add @sap-ux/ui5-library-reference-writer
```

```shell
pnpm add @sap-ux/ui5-library-reference-writer
```

--------------------------------

### Configure Jest for Puppeteer Integration

Source: https://github.com/sap/open-ux-tools/blob/main/packages/jest-runner-puppeteer/README.md

Example Jest configuration demonstrating how to integrate the global setup, teardown, environment, and additional setup files provided by @sap-ux/jest-runner-puppeteer.

```javascript
 
 const config = {
    globalSetup: '@sap-ux/jest-runner-puppeteer/dist/jest-puppeteer-setup.js',
    globalTeardown: '@sap-ux/jest-runner-puppeteer/dist/jest-puppeteer-teardown.js',
    testEnvironment: '@sap-ux/jest-runner-puppeteer/dist/jest-puppeteer-environment.js',
    setupFilesAfterEnv: ['expect-puppeteer', '@sap-ux/jest-runner-puppeteer/dist/jest-circus.setup.js'],
 }
```

--------------------------------

### Install @sap-ux/odata-vocabularies Library

Source: https://github.com/sap/open-ux-tools/blob/main/packages/odata-vocabularies/README.md

Instructions for installing the `@sap-ux/odata-vocabularies` library using popular Node.js package managers.

```Shell
npm install --save @sap-ux/odata-vocabularies
```

```Shell
yarn add @sap-ux/odata-vocabularies
```

```Shell
pnpm add @sap-ux/odata-vocabularies
```

--------------------------------

### Start SAP Fiori Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/telemetry/test/tools-suite-telemetry/fixtures/fiori_elements/README_Form.md

This command launches the generated SAP Fiori application in its default configuration, connecting to the configured OData service.

```Shell
npm start
```

--------------------------------

### Install @sap-ux/jest-file-matchers

Source: https://github.com/sap/open-ux-tools/blob/main/packages/jest-file-matchers/README.md

Instructions for installing the @sap-ux/jest-file-matchers library using different package managers.

```Shell
npm install --save @sap-ux/jest-file-matchers
```

```Shell
yarn add @sap-ux/jest-file-matchers
```

```Shell
pnpm add @sap-ux/jest-file-matchers
```

--------------------------------

### Launch Generated SAP Fiori Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-freestyle/expected-output/headless/simpleflightnodatasource/README.md

To start the generated SAP Fiori application, navigate to the app's root folder and execute the `npm start` command. This command launches the application, which was generated using SAP Fiori tools. Ensure an active NodeJS LTS version and compatible NPM version are installed as prerequisites.

```Shell
    npm start
```

--------------------------------

### Start SAP Fiori App with Mock Data

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/headless/lrop_v4_no_ui5_version/README.md

To run the application using mock data that reflects the OData Service URL supplied during application generation, navigate to the app's root folder and execute this command.

```shell
npm run start-mock
```

--------------------------------

### Start SAP Fiori Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-freestyle/expected-output/test_project_ff_worklist_v2/README.md

This command launches the generated SAP Fiori application in its default mode. It is typically used for development and testing against a live OData service.

```Shell
npm start
```

--------------------------------

### Install @sap-ux/fiori-elements-writer package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-elements-writer/README.md

Instructions for installing the `@sap-ux/fiori-elements-writer` package using npm, Yarn, and pnpm package managers.

```npm
npm install --save @sap-ux/fiori-elements-writer
```

```yarn
yarn add @sap-ux/fiori-elements-writer
```

```pnpm
pnpm add @sap-ux/fiori-elements-writer
```

--------------------------------

### Start SAP CAP Java Project

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/lrop_v4_cap_java/app/lrop_v4_cap_java/README.md

Instructions to start the generated SAP CAP Java backend project using Maven, which serves the Fiori application. After starting, navigate to the specified URL in your browser: http://localhost:8080/lrop_v4_cap_java/webapp/index.html

```Shell
mvn spring-boot:run
```

--------------------------------

### Install @sap-ux/create CLI

Source: https://github.com/sap/open-ux-tools/blob/main/packages/create/README.md

Provides commands to install the @sap-ux/create module using npm or npx. It suggests global installation or adding as a devDependency to avoid repeated downloads.

```sh
npm init @sap-ux@latest
# or
npx @sap-ux/create@latest
```

--------------------------------

### Verify @sap-ux/deploy-tooling CLI Installation

Source: https://github.com/sap/open-ux-tools/blob/main/packages/deploy-tooling/README.md

Commands to verify the successful local installation of the `@sap-ux/deploy-tooling` CLI by checking its help output using `npx` or direct execution from `node_modules`.

```bash
npx deploy -h
# or
./node_modules/.bin/deploy -h
```

--------------------------------

### Run Local Test with Cloud ABAP Environment

Source: https://github.com/sap/open-ux-tools/blob/main/examples/odata-cli/README.md

Executes the `cloud` test activity using `pnpm start` after configuring the Cloud ABAP system URL.

```bash
pnpm start cloud
```

--------------------------------

### Interactive Prompts for Fiori Elements Generator

Source: https://github.com/sap/open-ux-tools/blob/main/examples/simple-generator/README.md

An example of the interactive command-line prompts presented by the Yeoman generator, guiding the user to input details such as application name, template type, OData service URL, user credentials, and the main entity for the Fiori application.

```shell
? **Application** name myapp
? **Template** List Report
? **Service url** https://sapes5.sapdevcenter.com/sap/opu/odata/sap/SEPMRA_PROD_MAN
? **Username** YOUR_USER
? **Password** *******
? **Main entity** SEPMRA_C_PD_Product
```

--------------------------------

### Install @sap-ux/btp-utils Library

Source: https://github.com/sap/open-ux-tools/blob/main/packages/btp-utils/README.md

Commands to install the @sap-ux/btp-utils library using different Node.js package managers.

```Shell
npm install --save @sap-ux/btp-utils
```

```Shell
yarn add @sap-ux/btp-utils
```

```Shell
pnpm add @sap-ux/btp-utils
```

--------------------------------

### Run Local Test with ABAP Environment on SAP BTP

Source: https://github.com/sap/open-ux-tools/blob/main/examples/odata-cli/README.md

Executes the `btp` test activity using `pnpm start` after configuring the service key path.

```bash
pnpm start btp
```

--------------------------------

### Start SAP Fiori Application with Mock Data

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-freestyle/expected-output/test_project_ff_worklist_v2/README.md

This command launches the generated SAP Fiori application using mock data, reflecting the OData Service URL supplied during application generation. This is useful for offline development or when the backend service is not yet available.

```Shell
npm run start-mock
```

--------------------------------

### Run Local Test with SAP System

Source: https://github.com/sap/open-ux-tools/blob/main/examples/odata-cli/README.md

Executes the `abap` test activity using `pnpm start` after configuring the SAP system details.

```bash
pnpm start abap
```

--------------------------------

### Install @sap-ux/jest-runner-puppeteer

Source: https://github.com/sap/open-ux-tools/blob/main/packages/jest-runner-puppeteer/README.md

Instructions for installing the @sap-ux/jest-runner-puppeteer library using npm, Yarn, or pnpm.

```shell
npm install --save @sap-ux/jest-runner-puppeteer
```

```shell
yarn add @sap-ux/jest-runner-puppeteer
```

```shell
pnpm add @sap-ux/jest-runner-puppeteer
```

--------------------------------

### Install @sap-ux/ui5-info package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/ui5-info/README.md

Instructions to install the @sap-ux/ui5-info package using different Node.js package managers.

```npm
npm install --save @sap-ux/ui5-info
```

```yarn
yarn add @sap-ux/ui5-info
```

```pnpm
pnpm add @sap-ux/ui5-info
```

--------------------------------

### Start Generated SAP Fiori Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-freestyle/expected-output/simple/README.md

This command is used to launch the SAP Fiori application after it has been generated. It must be executed from the root directory of the generated application. Ensure that an active NodeJS LTS version and its associated supported NPM version are installed as pre-requisites.

```CLI
npm start
```

--------------------------------

### Start SAP Fiori Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/ovp_v2/README.md

Executes the default start script to launch the generated SAP Fiori application, connecting to the configured OData service.

```Shell
    npm start
```

--------------------------------

### Install @sap-ux/ui5-library-reference-inquirer

Source: https://github.com/sap/open-ux-tools/blob/main/packages/ui5-library-reference-inquirer/README.md

Commands to install the `@sap-ux/ui5-library-reference-inquirer` package using different Node.js package managers.

```npm
npm install --save @sap-ux/ui5-library-reference-inquirer
```

```yarn
yarn add @sap-ux/ui5-library-reference-inquirer
```

```pnpm
pnpm add @sap-ux/ui5-library-reference-inquirer
```

--------------------------------

### Install @sap-ux/cf-deploy-config-writer

Source: https://github.com/sap/open-ux-tools/blob/main/packages/cf-deploy-config-writer/README.md

Instructions for installing the `@sap-ux/cf-deploy-config-writer` package using different Node.js package managers.

```Shell
npm install --save @sap-ux/cf-deploy-config-writer
```

```Shell
yarn add @sap-ux/cf-deploy-config-writer
```

```Shell
pnpm add @sap-ux/cf-deploy-config-writer
```

--------------------------------

### Run @sap-ux/telemetry Example

Source: https://github.com/sap/open-ux-tools/blob/main/packages/telemetry/README.md

Steps to navigate to the telemetry package, configure the Azure Application Insights resource ID in a .env file, and execute the example script using pnpm.

```shell
# At project root folder of @sap-ux/telemetry
cd package/telemetry
# Create a file with name .env
# Add this line in .env file OpenUxTools_ResourceId=<your_azure_instrument_key>
pnpm example
```

--------------------------------

### Install @sap-ux/abap-deploy-config-writer

Source: https://github.com/sap/open-ux-tools/blob/main/packages/abap-deploy-config-writer/README.md

Instructions for installing the `@sap-ux/abap-deploy-config-writer` package using various Node.js package managers.

```shell
npm install --save @sap-ux/abap-deploy-config-writer
```

```shell
yarn add @sap-ux/abap-deploy-config-writer
```

```shell
pnpm add @sap-ux/abap-deploy-config-writer
```

--------------------------------

### Run Storybook for UI Examples

Source: https://github.com/sap/open-ux-tools/blob/main/examples/ui-prompting-examples/README.md

Executes the Storybook application to display UI examples. This command launches a browser window with prompt fields to capture information required for generating building blocks. The generated blocks are then inserted into a new Fiori elements application located in the `test-output/fe-app` folder, specifically in the view XML file within `webapp/ext`. An option to provide a custom project path is available in the footer under the 'Project Path' tab.

```bash
pnpm storybook
```

--------------------------------

### Start SAP CAP Local Development Server

Source: https://github.com/sap/open-ux-tools/blob/main/packages/deploy-config-sub-generator/test/headless/fixtures/test-apps/cf/capdestination/README.md

Use the `cds watch` command to launch the local development server for an SAP Cloud Application Programming Model (CAP) project. This command continuously monitors project files for changes and automatically reloads the application, facilitating rapid development.

```shell
cds watch
```

--------------------------------

### Start SAP Fiori Application with Mock Data

Source: https://github.com/sap/open-ux-tools/blob/main/packages/telemetry/test/tools-suite-telemetry/fixtures/fiori_elements/README_Form.md

This command launches the generated SAP Fiori application using mock data, reflecting the OData Service URL supplied during application generation. This is useful for development and testing without a live backend connection.

```Shell
npm run start-mock
```

--------------------------------

### Install @sap-ux/ui5-library-writer with Pnpm

Source: https://github.com/sap/open-ux-tools/blob/main/packages/ui5-library-writer/README.md

Command to install the `@sap-ux/ui5-library-writer` package using pnpm, adding it as a dependency.

```Shell
pnpm add @sap-ux/ui5-library-writer
```

--------------------------------

### Install @sap-ux/fe-fpm-writer Package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fe-fpm-writer/README.md

Instructions for installing the `@sap-ux/fe-fpm-writer` package using different Node.js package managers (npm, yarn, pnpm).

```Shell
npm install --save @sap-ux/fe-fpm-writer
```

```Shell
yarn add @sap-ux/fe-fpm-writer
```

```Shell
pnpm add @sap-ux/fe-fpm-writer
```

--------------------------------

### Run SAP Fiori App with Mock Data

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/alp_v2_no_opts/README.md

Use this command to start the SAP Fiori application with mock data, simulating the OData service. This is ideal for development and testing scenarios where a live backend is not available or desired. Ensure NodeJS LTS is installed.

```Shell
npm run start-mock
```

--------------------------------

### Install @sap-ux/nodejs-utils Package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/nodejs-utils/README.md

Instructions for installing the `@sap-ux/nodejs-utils` package using various Node.js package managers.

```Shell
npm install --save @sap-ux/nodejs-utils
```

```Shell
yarn add @sap-ux/nodejs-utils
```

```Shell
pnpm add @sap-ux/nodejs-utils
```

--------------------------------

### Install UI5 Application Writer Package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/ui5-application-writer/README.md

Instructions for installing the `@sap-ux/ui5-application-writer` package, a utility for writing basic UI5 applications, using different Node.js package managers.

```Npm
npm install --save @sap-ux/ui5-application-writer
```

```Yarn
yarn add @sap-ux/ui5-application-writer
```

```Pnpm
pnpm add @sap-ux/ui5-application-writer
```

--------------------------------

### Install @sap-ux/cds-annotation-parser

Source: https://github.com/sap/open-ux-tools/blob/main/packages/cds-annotation-parser/README.md

Commands to install the `@sap-ux/cds-annotation-parser` package using different Node.js package managers.

```npm
npm install --save @sap-ux/cds-annotation-parser
```

```yarn
yarn add @sap-ux/cds-annotation-parser
```

```pnpm
pnpm add @sap-ux/cds-annotation-parser
```

--------------------------------

### Install @sap-ux/ui5-library-writer with Yarn

Source: https://github.com/sap/open-ux-tools/blob/main/packages/ui5-library-writer/README.md

Command to install the `@sap-ux/ui5-library-writer` package using yarn, adding it as a dependency.

```Shell
yarn add @sap-ux/ui5-library-writer
```

--------------------------------

### Install SAP UX Mockserver Config Writer

Source: https://github.com/sap/open-ux-tools/blob/main/packages/mockserver-config-writer/README.md

Provides commands to install the `@sap-ux/mockserver-config-writer` package using popular Node.js package managers: npm, yarn, and pnpm.

```Npm
npm install --save @sap-ux/mockserver-config-writer
```

```Yarn
yarn add @sap-ux/mockserver-config-writer
```

```Pnpm
pnpm add @sap-ux/mockserver-config-writer
```

--------------------------------

### Install @sap-ux/text-document-utils package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/text-document-utils/README.md

Instructions for installing the @sap-ux/text-document-utils library using common Node.js package managers like npm, Yarn, and pnpm.

```Shell
npm install --save @sap-ux/text-document-utils
```

```Shell
yarn add @sap-ux/text-document-utils
```

```Shell
pnpm add @sap-ux/text-document-utils
```

--------------------------------

### Example HTTPS Proxy Configuration

Source: https://github.com/sap/open-ux-tools/blob/main/packages/axios-extension/README.adoc

Illustrates a concrete example of setting the `HTTPS_PROXY` environment variable with specific values for user, password, domain, and port. This demonstrates a typical setup for routing HTTPS traffic via a proxy.

```bash
export HTTPS_PROXY=http://user:password@proxy.domain.com:3128
```

--------------------------------

### Run @sap-ux/create CLI

Source: https://github.com/sap/open-ux-tools/blob/main/packages/create/README.md

Demonstrates how to execute the @sap-ux/create CLI after global or local installation.

```sh
# globally installed
sap-ux
# locally
npx sap-ux
```

--------------------------------

### Install @sap-ux/cap-config-writer Package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/cap-config-writer/README.md

Instructions for installing the @sap-ux/cap-config-writer package using different Node.js package managers.

```Npm
npm install --save @sap-ux/cap-config-writer
```

```Yarn
yarn add @sap-ux/cap-config-writer
```

```Pnpm
pnpm add @sap-ux/cap-config-writer
```

--------------------------------

### Configure Minimal UI5 Preview Middleware

Source: https://github.com/sap/open-ux-tools/blob/main/packages/preview-middleware/README.md

This configuration demonstrates the most basic setup for the `preview-middleware`, enabling a local FLP at `/test/flp.html` with an `info` log level. It ensures the middleware runs after `compression`.

```Yaml
server:
  customMiddleware:
  - name: preview-middleware
    afterMiddleware: compression
```

--------------------------------

### Install @sap-ux/xml-odata-annotation-converter Package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/xml-odata-annotation-converter/README.md

Provides commands to install the `@sap-ux/xml-odata-annotation-converter` package using popular Node.js package managers: npm, Yarn, and pnpm.

```npm
npm install --save @sap-ux/xml-odata-annotation-converter
```

```yarn
yarn add @sap-ux/xml-odata-annotation-converter
```

```pnpm
pnpm add @sap-ux/xml-odata-annotation-converter
```

--------------------------------

### Start SAP Fiori Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/lrop_v4/README.md

Launches the generated SAP Fiori application. This command starts the application in development mode, typically serving it from a local web server.

```Shell
npm start
```

--------------------------------

### Install @sap-ux/ui-components Package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/ui-components/README.md

This snippet provides commands to install the `@sap-ux/ui-components` library using different Node.js package managers. The library offers Fluent UI and React components for VSCode webview extensions.

```npm
npm install --save @sap-ux/ui-components
```

```yarn
yarn add @sap-ux/ui-components
```

```pnpm
pnpm add @sap-ux/ui-components
```

--------------------------------

### Configure Backend Proxy to Connect to a URL

Source: https://github.com/sap/open-ux-tools/blob/main/packages/backend-proxy-middleware/README.md

Example `ui5.yaml` configuration to forward requests starting with `/sap` to a specified backend URL using the `backend-proxy-middleware`.

```YAML
- name: backend-proxy-middleware
  afterMiddleware: compression
  configuration:
    backend:
      path: /sap
      url: https://my.backend.example:1234
```

--------------------------------

### Start SAP Fiori App

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/lrop_v2_dest/README.md

Launches the generated SAP Fiori application. This command starts the application in its default configuration, connecting to the configured OData service.

```Shell
npm start
```

--------------------------------

### Run CLI to Generate FPM Building Blocks

Source: https://github.com/sap/open-ux-tools/blob/main/examples/fe-fpm-cli/README.adoc

This command initiates a series of prompts to gather information for generating FPM-based building blocks. The generated blocks will be inserted into a new Fiori elements application within the `test-output/fe-app` folder, specifically in the `webapp/ext` folder's view XML file.

```bash
pnpm start
```

--------------------------------

### Start SAP Fiori Application in Development Mode

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/ovp_v4/README.md

To launch the generated SAP Fiori application for development, run this command from the app's root folder. It starts a local development server, enabling live preview and debugging of the application.

```Shell
npm start
```

--------------------------------

### Install @sap-ux/deploy-tooling CLI

Source: https://github.com/sap/open-ux-tools/blob/main/packages/deploy-tooling/README.md

Instructions to install the `@sap-ux/deploy-tooling` package using npm or yarn as a development dependency. This package provides CLI commands for deployment tasks.

```bash
`npm install @sap-ux/deploy-tooling --save-dev`
# or
yarn add @sap-ux/deploy-tooling --dev
```

--------------------------------

### SAP Fiori Launchpad and Adaptation Project Configuration Reference

Source: https://github.com/sap/open-ux-tools/blob/main/packages/preview-middleware/README.md

This section outlines the various configuration properties available for customizing the local SAP Fiori launchpad and defining backend connections for adaptation projects. Each entry specifies the option name, expected value type, whether it's optional or mandatory, its default setting, and a detailed explanation of its function.

```APIDOC
Configuration Options:
  flp:
    Value Type: ---
    Requirement Type: optional
    Default Value: ---
    Description: Configuration object for the local SAP Fiori launchpad
  flp.path:
    Value Type: string
    Requirement Type: optional
    Default Value: /test/flp.html
    Description: The mount point of the local SAP Fiori launchpad.
  flp.init:
    Value Type: string
    Requirement Type: optional
    Default Value: undefined
    Description: UI5 module/script to be executed after the standard initialization
  flp.intent:
    Value Type: ---
    Requirement Type: optional
    Default Value: ---
    Description: Intent object to be used for the application
  flp.intent.object:
    Value Type: string
    Requirement Type: optional
    Default Value: app
    Description: Name of the semantic object
  flp.intent.action:
    Value Type: string
    Requirement Type: optional
    Default Value: preview
    Description: Name of the action
  flp.apps:
    Value Type: array
    Requirement Type: optional
    Default Value: undefined
    Description: Additional local apps that are available in the local SAP Fiori launchpad
  flp.libs:
    Value Type: boolean
    Requirement Type: optional
    Default Value: false
    Description: Flag to add a generic script fetching the paths of used libraries not available in UI5. To disable it, set it to `false`. If not set, then the project is checked for a `load-reuse-libs` script and, if available, the libraries are fetched as well
  flp.theme:
    Value Type: string
    Requirement Type: optional
    Default Value: (calculated)
    Description: Name of the UI5 theme to be used (default is `sap_horizon` or the first entry in the sap.ui.supportedThemes list provided in the manifest.json file if `sap_horizon` is not contained in the list)
  flp.enhancedHomePage:
    Value Type: boolean
    Requirement Type: optional
    Default Value: false
    Description: Flag for enabling enhanced FLP homepage, available only from UI5 version 1.123.0 onwards
  adp.target:
    Value Type: ---
    Requirement Type: mandatory for adaptation projects
    Default Value: ---
    Description: Configuration object defining the connected back end
```

--------------------------------

### Install @sap-ux/ui-prompting Package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/ui-prompting/README.md

Instructions for installing the `@sap-ux/ui-prompting` library using different Node.js package managers (npm, yarn, pnpm). This library provides React components for building UI based on the Inquirer interface.

```Shell
npm install --save @sap-ux/ui-prompting
```

```Shell
yarn add @sap-ux/ui-prompting
```

```Shell
pnpm add @sap-ux/ui-prompting
```

--------------------------------

### Configure and Initialize SAP Fiori Launchpad Sandbox

Source: https://github.com/sap/open-ux-tools/blob/main/packages/deploy-config-sub-generator/test/headless/fixtures/test-apps/cf/caplcapmodeonly/app/feproject-ui/webapp/test/flpSandbox.html

This snippet sets up a local SAP Fiori Launchpad (FLP) sandbox environment for development and testing. It defines the `sap-ushell-config` object, specifying renderer settings, bootstrap plugins (like RuntimeAuthoringPlugin), and application tiles. It then initializes the UI5 core and creates the FLP renderer, placing it into the 'content' element.

```JavaScript
window["sap-ushell-config"] = { defaultRenderer: "fiori2", bootstrapPlugins: { "RuntimeAuthoringPlugin": { component: "sap.ushell.plugins.rta", config: { validateAppVersion: false } } }, renderers: { fiori2: { componentData: { config: { search: "hidden" } } } }, applications: { "headlesstestfeprojectui-tile": { title: "App Title", description: "An SAP Fiori application.", additionalInformation: "SAPUI5.Component=headless.test.feprojectui", applicationType: "URL", url: "../" } } };
// NON-SECURE setting for testing environment
sap.ui.getCore().attachInit(function () { // initialize the ushell sandbox component
  sap.ushell.Container.createRenderer().placeAt("content");
});
```

--------------------------------

### Map Feature ID to Token in Constants File

Source: https://github.com/sap/open-ux-tools/blob/main/packages/feature-toggle/README.md

TypeScript example showing how feature IDs are mapped to their corresponding GUID tokens within the application's constants file.

```typescript
const tokenToggleGuid: ExtensionConfigKeys = {
    'sap.ux.help.testBetaFeatures.enableAppStudioGDContribution': 'c8c52f0b-0d7d-4697-997a-d6f29814f42e',
    'sap.ux.help.testBetaFeatures.showTestGuides': 'fbb03f42-0a86-4fd5-9fc4-8c9b38a4d1a3'
} as ExtensionConfigKeys;
```

--------------------------------

### Run Test in AppStudio With Destination

Source: https://github.com/sap/open-ux-tools/blob/main/examples/odata-cli/README.md

Executes the default test activity using `pnpm start` within AppStudio, leveraging the configured destination service.

```bash
pnpm start
```

--------------------------------

### Start SAP Fiori Application with Mock Data

Source: https://github.com/sap/open-ux-tools/blob/main/packages/telemetry/test/tools-suite-telemetry/fixtures/fiori_elements/README_LROPv4.md

Instructions to launch the generated SAP Fiori application using mock data, reflecting the OData Service URL, by running `npm run start-mock` from the generated app root folder.

```Shell
npm run start-mock
```

--------------------------------

### Configure SAP Fiori Launchpad (ushell) with App and Plugin Settings

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/lrop_v2_eslint/webapp/test/flpSandbox.html

This JavaScript snippet defines the `sap-ushell-config` object, which is essential for setting up the SAP Fiori Launchpad. It includes configurations for the default renderer, bootstrap plugins like Runtime Authoring (RTA), and specific application tiles. The example shows how to define an application with a title, description, component information, and URL.

```JavaScript
{{appTitle}} window["sap-ushell-config"] = { defaultRenderer: "fiori2", bootstrapPlugins: { "RuntimeAuthoringPlugin": { component: "sap.ushell.plugins.rta", config: { validateAppVersion: false } } }, renderers: { fiori2: { componentData: { config: { search: "hidden", enableSearch: false } } } }, applications: { "testNameSpacelropv2eslint-tile": { title: "Project's \"Title\"", description: "Test 'Project' \"Description\"", additionalInformation: "SAPUI5.Component=testNameSpace.lropv2eslint", applicationType: "URL", url: "../" } } };
```

--------------------------------

### Start SAP Fiori Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-freestyle/expected-output/test_project_ff_list-detail/README.md

To launch the generated SAP Fiori application using live data, navigate to the app's root folder and execute this command. This is the standard way to run the application.

```Shell
npm start
```

--------------------------------

### Minimal ui5.yaml Configuration for Reload Middleware

Source: https://github.com/sap/open-ux-tools/blob/main/packages/reload-middleware/README.md

This example shows the simplest configuration required to enable the `reload-middleware` in your `ui5.yaml`. By default, it watches common webapp file extensions and starts the livereload server on port `35729`.

```YAML
server:
  customMiddleware:
  - name: reload-middleware
    afterMiddleware: compression
```

--------------------------------

### Start SAP Fiori Application with Mock Data

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-freestyle/expected-output/worklist_v2_scp/README.md

Launches the SAP Fiori application using mock data that reflects the OData Service URL supplied during application generation, useful for development without a live backend.

```Shell
npm run start-mock
```

--------------------------------

### Get UI5 versions with filtering options

Source: https://github.com/sap/open-ux-tools/blob/main/packages/ui5-info/README.md

Demonstrates how to use the `getUI5Versions` function from `@sap-ux/ui5-info` to retrieve a list of UI5 versions, applying filters such as minimum supported version and maintenance status. The example also shows the expected output structure.

```javascript
import { getUI5Versions, type UI5VersionFilterOptions } from '@sap-ux/ui5-info';

const filterOptions: UI5VersionFilterOptions = {
    minSupportedUI5Version: '1.84.0',
    includeMaintained: true
};
const ui5Versions = await getUI5Versions(filterOptions);
/**
   ui5Versions :
  [
    {
        "version": "1.119.0",
        "maintained": true
    },
    {
        "version": "1.117.0",
         "maintained": false
    },
    {
        "version": "1.114.0",
         "maintained": true
    },
    {
        "version": "1.108.0",
         "maintained": false
    },
    {
        "version": "1.96.0",
         "maintained": false
    },
    {
        "version": "1.84.0",
         "maintained": true
    }
]
 */
```

--------------------------------

### Serving Generic Static Resources Locally with Fiori Run

Source: https://github.com/sap/open-ux-tools/blob/main/packages/serve-static-middleware/README.md

This `ui5.yaml` configuration shows how to serve arbitrary static resources (e.g., images, libraries) locally using `npx fiori run`. It maps `/images` and `/libs` to specified local directories on your machine.

```YAML
server:
  customMiddleware:
  - name: serve-static-middleware
    afterMiddleware: compression
    configuration:
      paths:
        - path: /images
          src: "Path/To/images"
        - path: /libs
          src: "Path/To/libs"
```

--------------------------------

### Start SAP Fiori Application in Development Mode

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/alp_v2/README.md

This command initiates the SAP Fiori application, typically connecting to the configured OData service. It's used for standard development and testing against a live backend.

```Shell
npm start
```

--------------------------------

### Configure SAP Fiori Launchpad with Application and Plugins

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-freestyle/expected-output/headless/md/webapp/test/flpSandbox.html

This JavaScript snippet defines the global `sap-ushell-config` object, which is essential for setting up the SAP Fiori Launchpad. It specifies the default renderer, enables the Runtime Authoring Plugin for in-app extensibility, hides the search bar, and registers a Fiori application with its title, description, and URL.

```JavaScript
{{appTitle}} window["sap-ushell-config"] = { defaultRenderer: "fiori2", bootstrapPlugins: { "RuntimeAuthoringPlugin": { component: "sap.ushell.plugins.rta", config: { validateAppVersion: false } } }, renderers: { fiori2: { componentData: { config: { search: "hidden", enableSearch: false } } } }, applications: { "appnamespacemd-display": { title: "App Title", description: "An SAP Fiori application.", additionalInformation: "SAPUI5.Component=appnamespace.md", applicationType: "URL", url: "../" } } };
```

--------------------------------

### Start SAP Fiori App with Mock Data

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/alp_v4/README.md

To run the application using mock data that reflects the OData Service URL supplied during application generation, execute this command from the generated app root folder.

```Shell
npm run start-mock
```

--------------------------------

### Configure SAP Fiori Launchpad Applications and Initialize Renderer

Source: https://github.com/sap/open-ux-tools/blob/main/packages/cds-odata-annotation-converter/test/data/bookshop/app/fiori.html

This JavaScript snippet defines the 'sap-ushell-config' object on the window, which is used by SAP Fiori Launchpad to register applications. It sets up three applications: 'browse-books', 'manage-books', and 'manage-orders', each pointing to a specific URL and SAPUI5 component. After configuration, it initializes the SAP Fiori Launchpad renderer and places it into the 'content' element of the HTML page.

```JavaScript
window["sap-ushell-config"] = { defaultRenderer: "fiori2", applications: { "browse-books": { title: "Browse Books", description: "... testing FE v42", additionalInformation: "SAPUI5.Component=bookshop", applicationType : "URL", url: "/browse/webapp", navigationMode: "embedded" }, "manage-books": { title: "Manage Books", description: "... testing FE v42", additionalInformation: "SAPUI5.Component=admin", applicationType : "URL", url: "/admin/webapp", navigationMode: "embedded" }, "manage-orders": { title: "Manage Orders", description: "... testing FE v42", additionalInformation: "SAPUI5.Component=orders", applicationType : "URL", url: "/orders/webapp", navigationMode: "embedded" } } }; sap.ui.getCore().attachInit(()=> sap.ushell.Container.createRenderer().placeAt("content"))
```

--------------------------------

### Start SAP Fiori Application with Mock Data

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/alp_v2/README.md

This command launches the SAP Fiori application using mock data, which simulates the OData service responses. This is useful for front-end development when the backend service is not available or for isolated testing.

```Shell
npm run start-mock
```

--------------------------------

### Start SAP Fiori App with Live Data

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/alp_v4/README.md

To launch the generated SAP Fiori application using live OData service data, run this command from the app's root folder. This app was generated using the SAP Fiori tools - App Generator.

```Shell
npm start
```

--------------------------------

### Add HTML Files for Local Preview

Source: https://github.com/sap/open-ux-tools/blob/main/packages/create/README.md

Adds HTML files for local preview and testing to the project. It uses the configuration from the ui5.yaml as default, as provided by the fiori-tools-preview or preview-middleware.

```sh
sap-ux add html [path]
```

```APIDOC
Options:
-c | --config: path to project configuration file in YAML format, e.g.: -c ui5Custom.yaml
```

--------------------------------

### Run SAP Fiori App with Live Data

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/alp_v2_no_opts/README.md

Execute this command from the application's root folder to launch the generated SAP Fiori application. It connects to the live OData service URL specified during generation, providing real-time data. Ensure NodeJS LTS is installed.

```Shell
npm start
```

--------------------------------

### Add Fiori Tools App Reload Middleware to Existing UI5 Config (JavaScript)

Source: https://github.com/sap/open-ux-tools/blob/main/packages/ui5-config/README.md

This example shows how to load an existing `ui5.yaml` configuration from the file system, add the `fiori-tools-app-reload` middleware to it, and then persist the updated configuration back to the file system. This is useful for extending existing UI5 tooling setups with specific Fiori tools functionalities.

```javascript
// load a config from the filesytem
const ui5Config = await UI5Config.newInstance(fs.read('./ui5.yaml'));

// add a middlewre
ui5Config.addFioriToolsAppReloadMiddleware();

// write the changes back to the filestystem
fs.write('./ui5.yaml', ui5Config.toString());
```

--------------------------------

### Starting the SAP Fiori Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/lrop_v2_sap_system/README.md

Provides commands to launch the generated SAP Fiori application, both with live data and with mock data for development and testing. This requires an active NodeJS LTS version and associated NPM.

```Shell
npm start
```

```Shell
npm run start-mock
```

--------------------------------

### Start SAP Fiori Application with Mock Data

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/ovp_v4/README.md

This command allows running the SAP Fiori application using mock data, which simulates the OData Service URL provided during generation. It's ideal for development and testing scenarios where a live backend service is not available or desired.

```Shell
npm run start-mock
```

--------------------------------

### Troubleshoot Playwright Browser Installation

Source: https://github.com/sap/open-ux-tools/blob/main/packages/playwright/README.md

Instructions to resolve issues where Playwright fails to install default browsers. This provides commands to manually install all supported browsers, a specific browser like Chromium, or to view available installation options.

```Shell
npx playwright install
```

```Shell
npx playwright install chromium
```

```Shell
npx playwright install --help
```

--------------------------------

### Configure SAP Fiori Launchpad and Initialize Ushell Sandbox

Source: https://github.com/sap/open-ux-tools/blob/main/packages/adp-tooling/test/fixtures/webide-adaptation-project/webapp/test/flpSandbox.html

This JavaScript code block configures the `sap-ushell-config` global object to define Fiori Launchpad settings, including hiding the search bar and registering a sample application named 'adaptationproject-display'. It then attaches an `init` event listener to `sap.ui.getCore()` to create and place the ushell sandbox renderer into an HTML element with the ID 'content' once the UI5 core is initialized. This setup is typically used for local development or testing of Fiori applications.

```JavaScript
window["sap-ushell-config"] = { defaultRenderer : "fiori2", renderers: { fiori2: { componentData: { config: { search: "hidden" } } } }, applications: { "adaptationproject-display": { title: "migrate test", additionalInformation: "SAPUI5.Component=sap.ui.demoapps.rta.fiorielements", applicationType: "URL", url: "/webapp/parent" } } }; // NON-SECURE setting for testing environment sap.ui.getCore().attachInit(function() { // initialize the ushell sandbox component sap.ushell.Container.createRenderer().placeAt("content"); });
```

--------------------------------

### Install pnpm Globally using npm

Source: https://github.com/sap/open-ux-tools/blob/main/README.md

To set up the local development environment, `pnpm` must be installed globally. This command uses `npm` to install `pnpm` as a global package, making it available for managing project dependencies.

```shell
npm install -g pnpm
```

--------------------------------

### Configure SAP Fiori Launchpad and Application Tile

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/headless/lrop_v4_no_ui5_version/webapp/test/flpSandbox.html

This JavaScript snippet defines the `sap-ushell-config` object, which configures the SAP Fiori Launchpad. It sets up default renderers, enables the Runtime Authoring Plugin, hides the search bar, and defines a specific application tile with its title, description, and URL.

```JavaScript
window["sap-ushell-config"] = { defaultRenderer: "fiori2", bootstrapPlugins: { "RuntimeAuthoringPlugin": { component: "sap.ushell.plugins.rta", config: { validateAppVersion: false } } }, renderers: { fiori2: { componentData: { config: { search: "hidden", enableSearch: false } } } }, applications: { "testnamepsacelropv4noui5versio-tile": { title: "Project's \"Title\"", description: "Test 'Project' \"Description\"", additionalInformation: "SAPUI5.Component=testnamepsace.lropv4noui5version", applicationType: "URL", url: "../" } } };
```

--------------------------------

### Configure SAP Fiori Launchpad Sandbox and UI5 Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fe-fpm-writer/test/test-input/integration/custom-page-app/js/webapp/test/flpSandbox.html

This JavaScript code initializes the SAP Fiori Launchpad (ushell) sandbox configuration. It sets up the default Fiori2 renderer, includes the Runtime Authoring plugin for UI adaptations, and defines a custom SAPUI5 application tile with its properties and URL. Finally, it attaches an init function to `sap.ui.getCore()` to create and place the ushell renderer.

```JavaScript
{{appTitle}} window["sap-ushell-config"] = { defaultRenderer: "fiori2", bootstrapPlugins: { "RuntimeAuthoringPlugin": { component: "sap.ushell.plugins.rta", config: { validateAppVersion: false } } }, renderers: { fiori2: { componentData: { config: { search: "hidden", enableSearch: false } } } }, applications: { "sapfedemocustomPageAppJs-tile": { title: "App Title", description: "A Fiori application.", additionalInformation: "SAPUI5.Component=sap.fe.demo.customPageAppJs", applicationType: "URL", url: "../" } } }; sap.ui.getCore().attachInit(function () { // initialize the ushell sandbox component sap.ushell.Container.createRenderer().placeAt("content"); });
```

--------------------------------

### Configure SAP Fiori Launchpad and Bootstrap SAPUI5 Application

Source: https://github.com/sap/open-ux-tools/blob/main/packages/deploy-config-sub-generator/test/headless/fixtures/test-apps/cf/capjavadestination/app/feproject-ui/webapp/index.html

This JavaScript snippet initializes the `sap-ushell-config` global object to define an SAP Fiori application ('fe-lrop-v4') within the Fiori Launchpad. It specifies the application's title, description, component, type, URL, and navigation mode. Subsequently, it attaches an initialization function to `sap.ui.getCore()` to create and place the Fiori Launchpad renderer into the 'content' element, effectively bootstrapping the SAPUI5 application.

```JavaScript
window['sap-ushell-config'] = { defaultRenderer: 'fiori2', applications: { 'fe-lrop-v4': { title: 'App Title', description: 'An SAP Fiori application.', additionalInformation: 'SAPUI5.Component=headless.test.feprojectui', applicationType: 'URL', url: './', navigationMode: 'embedded' } } }; sap.ui.getCore().attachInit(function() { sap.ushell.Container.createRenderer().placeAt('content'); });
```

--------------------------------

### Common Options for @sap-ux/create Commands

Source: https://github.com/sap/open-ux-tools/blob/main/packages/create/README.md

Lists general options applicable to various commands within the @sap-ux/create CLI, including help, verbose output, and simulation mode.

```APIDOC
Common Options:
-h | --help: display help and options for command
-v | --verbose: show verbose information
-s | --simulate: simulate only do not write config; sets also --verbose
```

--------------------------------

### Install @sap-ux/ui5-library-writer with Npm

Source: https://github.com/sap/open-ux-tools/blob/main/packages/ui5-library-writer/README.md

Command to install the `@sap-ux/ui5-library-writer` package using npm, saving it as a dependency.

```Shell
npm install --save @sap-ux/ui5-library-writer
```

--------------------------------

### Integrating Custom Init Script via ui5.yaml

Source: https://github.com/sap/open-ux-tools/blob/main/packages/preview-middleware/README.md

This YAML configuration demonstrates how to integrate the externalized custom init script into the SAP Fiori Launchpad sandbox using the `preview-middleware`. The `flp.init` property specifies the path to the `test/init.ts` file, ensuring the custom logic is executed during the sandbox setup.

```YAML
server:
  customMiddleware:
  - name: preview-middleware
    afterMiddleware: compression
    configuration:
      flp:
        init: /test/init # <-- path to your custom init script
```

--------------------------------

### Configure SAP Fiori Launchpad Application and Initialize SAPUI5 Core

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-freestyle-writer/templates/common/add/1.120.0/webapp/test/flpSandbox.html

This JavaScript snippet defines the `sap-ushell-config` object to set up a Fiori Launchpad application. It includes settings for Runtime Authoring (RTA), disables search, and defines application metadata such as title, description, and component information. It also conditionally initializes the SAPUI5 core and places the Fiori renderer based on `appOptions.loadReuseLibs`.

```JavaScript
window["sap-ushell-config"] = {
  defaultRenderer: "fiori2",
  bootstrapPlugins: {
    "RuntimeAuthoringPlugin": {
      component: "sap.ushell.plugins.rta",
      config: {
        validateAppVersion: false
      }
    }
  },
  renderers: {
    fiori2: {
      componentData: {
        config: {
          search: "hidden",
          enableSearch: false
        }
      }
    }
  },
  applications: {
    "<%- app.flpAppId %>": {
      title: "<%- escapeFLPText(app.title) %>",
      description: "<%- escapeFLPText(app.description) %>",
      additionalInformation: "SAPUI5.Component=<%- app.id %>",
      applicationType: "URL",
      url: "../"
    }
  }
};
<% if (appOptions.loadReuseLibs) { %> <% } else { %>
sap.ui.getCore().attachInit(function () {
  sap.ushell.Container.createRenderer().placeAt("content");
});
<% } %>
```

--------------------------------

### Start SAP Fiori Application with Mock Data

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/ovp_v2/README.md

Executes the mock data start script to launch the generated SAP Fiori application, using local mock data that reflects the OData Service URL.

```Shell
    npm run start-mock
```

--------------------------------

### Install @sap-ux/odata-service-writer

Source: https://github.com/sap/open-ux-tools/blob/main/packages/odata-service-writer/README.md

Provides commands to install the @sap-ux/odata-service-writer package using npm, yarn, or pnpm.

```Shell
npm install --save @sap-ux/odata-service-writer
```

```Shell
yarn add @sap-ux/odata-service-writer
```

```Shell
pnpm add @sap-ux/odata-service-writer
```

--------------------------------

### Minimal Configuration for ui5-proxy-middleware

Source: https://github.com/sap/open-ux-tools/blob/main/packages/ui5-proxy-middleware/README.md

Shows the minimal `ui5.yaml` configuration required to use the middleware. All requests to `/resources` and `/test-resources` will be proxied to the latest UI5 version at `https://ui5.sap.com`.

```yaml
server:
  customMiddleware:
  - name: ui5-proxy-middleware
    afterMiddleware: compression
```

--------------------------------

### Install @sap-ux/ui5-application-inquirer Package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/ui5-application-inquirer/README.md

Commands to install the `@sap-ux/ui5-application-inquirer` package using different Node.js package managers.

```npm
npm install --save @sap-ux/ui5-application-inquirer
```

```yarn
yarn add @sap-ux/ui5-application-inquirer
```

```pnpm
pnpm add @sap-ux/ui5-application-inquirer
```

--------------------------------

### Install @sap-ux/telemetry Library

Source: https://github.com/sap/open-ux-tools/blob/main/packages/telemetry/README.md

Instructions for installing the @sap-ux/telemetry library using different Node.js package managers.

```npm
npm install --save @sap-ux/telemetry
```

```yarn
yarn add @sap-ux/telemetry
```

```pnpm
pnpm add @sap-ux/telemetry
```

--------------------------------

### Configure SAP Fiori Launchpad with Application Tile and RTA Plugin

Source: https://github.com/sap/open-ux-tools/blob/main/packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/feop_v4_cap/app/feop_v4_cap/webapp/test/flpSandbox.html

This JavaScript code initializes the SAP Fiori Launchpad (FLP) by setting up the 'sap-ushell-config' object. It specifies 'fiori2' as the default renderer, integrates the Runtime Authoring (RTA) plugin, and disables the search bar. Additionally, it defines a custom application tile with a title, description, and URL, and then renders the FLP into the 'content' element.

```JavaScript
window["sap-ushell-config"] = { defaultRenderer: "fiori2", bootstrapPlugins: { "RuntimeAuthoringPlugin": { component: "sap.ushell.plugins.rta", config: { validateAppVersion: false } } }, renderers: { fiori2: { componentData: { config: { search: "hidden", enableSearch: false } } } }, applications: { "testNameSpacefeopv4cap-tile": { title: "Project's \"Title\"", description: "Test 'Project' \"Description\"", additionalInformation: "SAPUI5.Component=testNameSpace.feopv4cap", applicationType: "URL", url: "../" } } }; sap.ui.getCore().attachInit(function () { sap.ushell.Container.createRenderer().placeAt("content"); });
```

--------------------------------

### Install @sap-ux/flp-config-inquirer Package

Source: https://github.com/sap/open-ux-tools/blob/main/packages/flp-config-inquirer/README.md

Instructions for installing the `@sap-ux/flp-config-inquirer` package using different Node.js package managers.

```npm
npm install --save @sap-ux/flp-config-inquirer
```

```yarn
yarn add @sap-ux/flp-config-inquirer
```

```pnpm
pnpm add @sap-ux/flp-config-inquirer
```

--------------------------------

### Install @sap-ux/feature-toggle Module

Source: https://github.com/sap/open-ux-tools/blob/main/packages/feature-toggle/README.md

Instructions for installing the @sap-ux/feature-toggle module using different Node.js package managers.

```npm
npm install --save @sap-ux/feature-toggle
```

```yarn
yarn add @sap-ux/feature-toggle
```

```pnpm
pnpm add @sap-ux/feature-toggle
```