Skip to content

Commit 9b49ffc

Browse files
committed
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
1 parent 2ae42ca commit 9b49ffc

37 files changed

+19828
-241
lines changed

.editorconfig

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# EditorConfig helps developers define and maintain consistent
2+
# coding styles between different editors and IDEs
3+
# editorconfig.org
4+
5+
root = true
6+
7+
[*]
8+
# We recommend you to keep these unchanged
9+
end_of_line = lf
10+
charset = utf-8
11+
trim_trailing_whitespace = true
12+
insert_final_newline = true
13+
14+
# Change these settings to your own preference
15+
indent_style = tab
16+
indent_size = 2
17+
18+
[*.{yaml,yml}]
19+
indent_style = space
20+
21+
[*.md]
22+
indent_style = unset
23+
trim_trailing_whitespace = false

.github/workflows/deploy.yaml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Deploy TypeScript Application to Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
16+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
17+
concurrency:
18+
group: "pages"
19+
cancel-in-progress: false
20+
21+
jobs:
22+
build:
23+
runs-on: ubuntu-latest
24+
steps:
25+
- name: Checkout
26+
uses: actions/checkout@v4
27+
28+
- name: Setup Node.js
29+
uses: actions/setup-node@v4
30+
with:
31+
node-version: 22
32+
cache: "npm"
33+
34+
- name: Setup Pages
35+
uses: actions/configure-pages@v5
36+
37+
- name: Install dependencies
38+
run: npm ci
39+
40+
- name: Build
41+
run: npm run build:opt
42+
43+
- name: Upload artifact
44+
uses: actions/upload-pages-artifact@v3
45+
with:
46+
path: ./dist
47+
48+
deploy:
49+
environment:
50+
name: github-pages
51+
url: ${{ steps.deployment.outputs.page_url }}
52+
runs-on: ubuntu-latest
53+
needs: build
54+
steps:
55+
- name: Deploy to GitHub Pages
56+
id: deployment
57+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# build results
2+
dist
3+
coverage
4+
report
5+
.nyc_output
6+
7+
# Logs
8+
logs
9+
*.log
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
14+
# Dependency directories
15+
node_modules/
16+
17+
.DS_Store
18+
.env
19+
20+
.ui5-tooling-modules

LICENSES/Apache-2.0.txt

Lines changed: 0 additions & 201 deletions
This file was deleted.

README.md

Lines changed: 39 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,58 @@
1-
# SAP-samples/repository-template
2-
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.
1+
# UXC Seamless Integration
32

4-
# Containing Files
3+
[![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/uxc-integration)](https://api.reuse.software/info/github.com/SAP-samples/uxc-integration)
4+
[![GitHub license](https://img.shields.io/github/license/SAP-samples/uxc-integration)](https://github.com/SAP-samples/uxc-integration/blob/main/LICENSE)
55

6-
1. The LICENSE file:
7-
In most cases, the license for SAP sample projects is `Apache 2.0`.
6+
## Description
87

9-
2. The REUSE.toml file:
10-
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.
8+
## Requirements
119

12-
3. The README.md file (this file):
13-
Please edit this file as it is the primary description file for your project. You can find some placeholder titles for sections below.
10+
Either [npm](https://www.npmjs.com/), [yarn](https://yarnpkg.com/), or [pnpm](https://pnpm.io/) for dependency management.
1411

15-
# [Title]
16-
<!-- Please include descriptive title -->
12+
## Download and Installation
1713

18-
<!--- Register repository https://api.reuse.software/register, then add REUSE badge:
19-
[![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/REPO-NAME)](https://api.reuse.software/info/github.com/SAP-samples/REPO-NAME)
20-
-->
14+
1. Clone the project:
2115

22-
## Description
23-
<!-- Please include SEO-friendly description -->
16+
```sh
17+
git clone https://github.com/SAP-samples/uxc-integration.git
18+
cd uxc-integration
19+
```
2420

25-
## Requirements
21+
(or download from https://github.com/SAP-samples/uxc-integration/archive/main.zip)
2622

27-
## Download and Installation
23+
2. Use npm (or any other package manager) to install the dependencies:
24+
25+
```sh
26+
npm install
27+
```
28+
29+
## Run the App
30+
31+
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):
32+
33+
```sh
34+
npm start
35+
```
36+
37+
As shown in the terminal after executing this command, the app is then running on http://localhost:8080/index.html.<br>
38+
A browser window with this URL should automatically open.
39+
40+
## Debug the App
41+
42+
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>
43+
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.
2844

2945
## Known Issues
30-
<!-- You may simply state "No known issues. -->
46+
47+
No known issues at this time.
3148

3249
## How to obtain support
33-
[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.
34-
50+
[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.
51+
3552
For additional support, [ask a question in SAP Community](https://answers.sap.com/questions/ask.html).
3653

3754
## Contributing
3855
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/).
3956

4057
## License
41-
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.
58+
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.

0 commit comments

Comments
 (0)