chore: set up project structure and add core files

- Add configuration files (.editorconfig, .gitignore, eslint, tsconfig, etc.)
- Add initial UI5 app structure (controllers, views, models, assets)
- Update README and REUSE.toml
- Remove unused Apache-2.0 license
- Add deployment workflow

Author: kgogov

.editorconfig

@@ -0,0 +1,23 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+# Change these settings to your own preference
+indent_style = tab
+indent_size = 2
+
+[*.{yaml,yml}]
+indent_style = space
+
+[*.md]
+indent_style = unset
+trim_trailing_whitespace = false

.github/workflows/deploy.yaml

@@ -0,0 +1,57 @@
+name: Deploy TypeScript Application to Pages
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: "npm"
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build:opt
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,20 @@
+# build results
+dist
+coverage
+report
+.nyc_output
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Dependency directories
+node_modules/
+
+.DS_Store
+.env
+
+.ui5-tooling-modules

README.md

@@ -1,41 +1,62 @@
-# SAP-samples/repository-template
-This default template for SAP Samples repositories includes files for README, LICENSE, and REUSE.toml. All repositories on github.com/SAP-samples will be created based on this template.
+# UXC Seamless Integration
 
-# Containing Files
+[![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/uxc-integration)](https://api.reuse.software/info/github.com/SAP-samples/uxc-integration)
+[![GitHub license](https://img.shields.io/github/license/SAP-samples/uxc-integration)](https://github.com/SAP-samples/uxc-integration/blob/main/LICENSE)
 
-1. The LICENSE file:
-In most cases, the license for SAP sample projects is `Apache 2.0`.
+## Description
 
-2. The REUSE.toml file: 
-The [Reuse Tool](https://reuse.software/) must be used for your samples project. You can find the REUSE.toml in the project initial. Please replace the parts inside the single angle quotation marks < > by the specific information for your repository.
+This sample project demonstrates the seamless integration of [UI5 Web Components](https://github.com/SAP/ui5-webcomponents) into the [OpenUI5](https://github.com/SAP/openui5) framework. The goal is to showcase how modern UI5 Web Components can be used alongside classic OpenUI5 controls within a single application, enabling developers to take advantage of the latest UI technologies without sacrificing compatibility or productivity.
 
-3. The README.md file (this file):
-Please edit this file as it is the primary description file for your project. You can find some placeholder titles for sections below.
+By using this sample, you can explore best practices for embedding UI5 Web Components in OpenUI5 views, handling interoperability, and leveraging the strengths of both frameworks. This integration pattern helps modernize SAP Fiori applications and extend their capabilities with reusable, standards-based UI elements.
 
-# [Title]
-<!-- Please include descriptive title -->
+## Requirements
 
-<!--- Register repository https://api.reuse.software/register, then add REUSE badge:
-[![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/REPO-NAME)](https://api.reuse.software/info/github.com/SAP-samples/REPO-NAME)
--->
+Either [npm](https://www.npmjs.com/), [yarn](https://yarnpkg.com/), or [pnpm](https://pnpm.io/) for dependency management.
 
-## Description
-<!-- Please include SEO-friendly description -->
+## Download and Installation
 
-## Requirements
+1. Clone the project:
 
-## Download and Installation
+```sh
+git clone https://github.com/SAP-samples/uxc-integration.git
+cd uxc-integration
+```
+
+(or download from https://github.com/SAP-samples/uxc-integration/archive/main.zip)
+
+2. Use npm (or any other package manager) to install the dependencies:
+
+```sh
+npm install
+```
+
+## Run the App
+
+Execute the following command to run the app locally for development in watch mode (the browser reloads the app automatically when there are changes in the source code):
+
+```sh
+npm start
+```
+
+As shown in the terminal after executing this command, the app is then running on http://localhost:8080/index.html.<br>
+A browser window with this URL should automatically open.
+
+## Debug the App
+
+In the browser, you can directly debug the original TypeScript code, which is supplied via sourcemaps (need to be enabled in the browser's developer console if it does not work straight away).<br>
+If the browser doesn't automatically jump to the TypeScript code when setting breakpoints, use e.g. `Ctrl`/`Cmd` + `P` in Chrome to open the `*.ts` file you want to debug.
 
 ## Known Issues
-<!-- You may simply state "No known issues. -->
+
+No known issues at this time.
 
 ## How to obtain support
-[Create an issue](https://github.com/SAP-samples/<repository-name>/issues) in this repository if you find a bug or have questions about the content.
- 
+[Create an issue](https://github.com/SAP-samples/uxc-integration/issues) in this repository if you find a bug or have questions about the content.
+
 For additional support, [ask a question in SAP Community](https://answers.sap.com/questions/ask.html).
 
 ## Contributing
 If you wish to contribute code, offer fixes or improvements, please send a pull request. Due to legal reasons, contributors will be asked to accept a DCO when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/).
 
 ## License
-Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSE) file.
+Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSE) file.

REUSE.toml

@@ -1,23 +1,11 @@
 version = 1
-SPDX-PackageName = "<YOUR-REPO-NAME>"
-SPDX-PackageSupplier = "<YOUR-CONTACT (MAIL ADDRESS ETC.)>"
-SPDX-PackageDownloadLocation = "<https://github.com/sap-samples/YOUR-REPO-NAME>"
+SPDX-PackageName = "uxc-integration"
+SPDX-PackageSupplier = "[email protected]"
+SPDX-PackageDownloadLocation = "https://github.com/sap-samples/uxc-integration"
 SPDX-PackageComment = "The code in this project may include calls to APIs (\"API Calls\") of\n SAP or third-party products or services developed outside of this project\n (\"External Products\").\n \"APIs\" means application programming interfaces, as well as their respective\n specifications and implementing code that allows software to communicate with\n other software.\n API Calls to External Products are not licensed under the open source license\n that governs this project. The use of such API Calls and related External\n Products are subject to applicable additional agreements with the relevant\n provider of the External Products. In no event shall the open source license\n that governs this project grant any rights in or to any External Products,or\n alter, expand or supersede any terms of the applicable additional agreements.\n If you have a valid license agreement with SAP for the use of a particular SAP\n External Product, then you may make use of any API Calls included in this\n project's code for that SAP External Product, subject to the terms of such\n license agreement. If you do not have a valid license agreement for the use of\n a particular SAP External Product, then you may only make use of any API Calls\n in this project for that SAP External Product for your internal, non-productive\n and non-commercial test and evaluation of such API Calls. Nothing herein grants\n you any rights to use or access any SAP External Product, or provide any third\n parties the right to use of access any SAP External Product, through API Calls."
 
 [[annotations]]
-path = "<YOUR-FILE-OR-FOLDER-LIST>"
+path = "**"
 precedence = "aggregate"
-SPDX-FileCopyrightText = "<YEARS-RELEVANT-FOR-YOUR-PROJECT> SAP SE or an SAP affiliate company and <YOUR-PROJECT-NAME> contributors"
-SPDX-License-Identifier = "Apache-2.0"
-
-[[annotations]]
-path = "<THIRD-PARTY-FILE-OR-FOLDER-LIST>"
-precedence = "aggregate"
-SPDX-FileCopyrightText = "<COPYRIGHT-OF-THIRD-PARTY-CODE>"
-SPDX-License-Identifier = "<LICENSE-OF-THIRD-PARTY-CODE>"
-
-[[annotations]]
-path = "<ANOTHER-THIRD-PARTY-FILE-OR-FOLDER-LIST>"
-precedence = "aggregate"
-SPDX-FileCopyrightText = "<COPYRIGHT-OF-ANOTHER-THIRD-PARTY-CODE>"
-SPDX-License-Identifier = "<LICENSE-OF-ANOTHER- THIRD-PARTY-CODE>"
+SPDX-FileCopyrightText = "2025 SAP SE or an SAP affiliate company and uxc-integration contributors"
+SPDX-License-Identifier = "Apache-2.0"

eslint.config.mjs

@@ -0,0 +1,28 @@
+import eslint from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+	eslint.configs.recommended,
+	...tseslint.configs.recommended,
+	...tseslint.configs.recommendedTypeChecked,
+	{
+		languageOptions: {
+			globals: {
+				...globals.browser,
+				sap: "readonly"
+			},
+			ecmaVersion: 2023,
+			parserOptions: {
+				project: [
+					"./tsconfig.json",
+					"./webapp/test/e2e/tsconfig.json"
+				],
+				tsconfigRootDir: import.meta.dirname
+			}
+		}
+	},
+	{
+		ignores: ["eslint.config.mjs", "webapp/test/e2e/**"]
+	}
+);