|
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 |
3 | 2 |
|
4 |
| -# Containing Files |
| 3 | +[](https://api.reuse.software/info/github.com/SAP-samples/uxc-integration) |
| 4 | +[](https://github.com/SAP-samples/uxc-integration/blob/main/LICENSE) |
5 | 5 |
|
6 |
| -1. The LICENSE file: |
7 |
| -In most cases, the license for SAP sample projects is `Apache 2.0`. |
| 6 | +## Description |
8 | 7 |
|
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 |
11 | 9 |
|
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. |
14 | 11 |
|
15 |
| -# [Title] |
16 |
| -<!-- Please include descriptive title --> |
| 12 | +## Download and Installation |
17 | 13 |
|
18 |
| -<!--- Register repository https://api.reuse.software/register, then add REUSE badge: |
19 |
| -[](https://api.reuse.software/info/github.com/SAP-samples/REPO-NAME) |
20 |
| ---> |
| 14 | +1. Clone the project: |
21 | 15 |
|
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 | +``` |
24 | 20 |
|
25 |
| -## Requirements |
| 21 | +(or download from https://github.com/SAP-samples/uxc-integration/archive/main.zip) |
26 | 22 |
|
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. |
28 | 44 |
|
29 | 45 | ## Known Issues
|
30 |
| -<!-- You may simply state "No known issues. --> |
| 46 | + |
| 47 | +No known issues at this time. |
31 | 48 |
|
32 | 49 | ## 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 | + |
35 | 52 | For additional support, [ask a question in SAP Community](https://answers.sap.com/questions/ask.html).
|
36 | 53 |
|
37 | 54 | ## Contributing
|
38 | 55 | 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/).
|
39 | 56 |
|
40 | 57 | ## 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