Quick Setup with GitHub Codespaces¶
The postCreateCommand will automatically install all dependencies.
This will take a few minutes.
- Node.js Versions 16.18.0, 18.12.0, or later
Install required NPM Packages¶
To quickly start the test environment, see here. See detailed information below.
This is the basic setting-up to continue with the next steps.
Run build watch¶
To start develop, you first run the watch command, to rebuild everytime you change something in the
The command will rebuild with the UI5 Tooling and place the result in the
dist folder. The test apps will consume the control from there.
This will not reload your app automatically, you have to reload the app manually.
Start CAP server¶
The CAP Server is currently very basic and provide a Order Entity with OrderItems. All the apps will consume from this server.
Start UI5 Apps¶
Under the folder
./examples/packages are all the UI5 Apps that are setup for the Consumption of the Custom Control.
There are five different apps for differenct scenarios (OData V2 Fiori Elements, V2 Freestyle, V2 FE Non Draft, V4 FE, V4 FPM).
There are currently only with version
1.108. For testing, these apps are copied and tested with other maintenance versions.
If you want to test with lower maintenance versions, just run this command:
npm run copyTestApps
This will copy the apps according to this json file.
# Start Test Apps npm run start:v4fe:108 npm run start:v2fe:108 # Alternative with pnpm pnpm --filter ordersv2fe108 start pnpm --filter ordersv4fe108 start # Run other apps after coping pnpm --filter ordersv2fe96 start pnpm --filter ordersv2fe84 start pnpm --filter ordersv2fe71 start pnpm --filter ordersv4fe96 start ...
Run wdi5 Tests¶
To run the wdi5 tests, the CAP server and the corresponding app must already be running.
You can run the test for the OData V4 UI5 Version 108 with this command:
More Info on the wdi5 Tests site.
To create a automatic changelog, we use the angular commit message guidelines.
The commit starts with the
type and a optional
feat(api). Possible types are listed here. Scopes can be freely namend or omitted.
A few examples:
feat(api): add new create api for customer
fix(api): edge case when customer is from EU
chore(workflow): changed commiting username
docs: typo in readme