{"id":20484927,"url":"https://github.com/sap-samples/ui5-deployments","last_synced_at":"2025-04-13T14:52:49.402Z","repository":{"id":63782675,"uuid":"560944489","full_name":"SAP-samples/ui5-deployments","owner":"SAP-samples","description":"Showcases a simple UI5 freestyle application and its deployment options to SAP BTP, Cloud Foundry Environment","archived":false,"fork":false,"pushed_at":"2025-03-07T20:50:07.000Z","size":285,"stargazers_count":24,"open_issues_count":0,"forks_count":5,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-27T05:51:10.438Z","etag":null,"topics":["approuter","cloud-foundry","cloudfoundry","managed-approuter","mta","open-source","sample","sample-code","sap-btp","sapui5","standalone-approuter","ui5"],"latest_commit_sha":null,"homepage":"https://blogs.sap.com/2022/11/01/build-and-deploy-ui5-freestyle-applications-to-sap-btp-cloud-foundry-environment/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SAP-samples.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-11-02T15:49:11.000Z","updated_at":"2025-03-07T20:50:07.000Z","dependencies_parsed_at":"2023-01-23T19:45:56.472Z","dependency_job_id":null,"html_url":"https://github.com/SAP-samples/ui5-deployments","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fui5-deployments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fui5-deployments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fui5-deployments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fui5-deployments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SAP-samples","download_url":"https://codeload.github.com/SAP-samples/ui5-deployments/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248732509,"owners_count":21152851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["approuter","cloud-foundry","cloudfoundry","managed-approuter","mta","open-source","sample","sample-code","sap-btp","sapui5","standalone-approuter","ui5"],"created_at":"2024-11-15T16:26:34.556Z","updated_at":"2025-04-13T14:52:49.396Z","avatar_url":"https://github.com/SAP-samples.png","language":"JavaScript","readme":"# Build \u0026 Deploy SAPUI5 Freestyle Applications to SAP BTP, Cloud Foundry Environment\n[![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/ui5-deployments)](https://api.reuse.software/info/github.com/SAP-samples/ui5-deployments)\n## Intro\nThis repo aims to showcase a simple UI5 freestyle application that can be deployed to SAP BTP, Cloud Foundry Environment with:\n- Managed approuter setup\n- Standalone approuter setup\n- Hybrid setup\n\n\u003cimg width=\"1262\" alt=\"\" src=\"https://user-images.githubusercontent.com/7225881/199363555-10de43ac-80c9-493f-b849-b7675b7c1df3.png\"\u003e\n\nA full explanation can be found in this [SAP Community blog post](https://blogs.sap.com/2022/11/01/build-and-deploy-ui5-freestyle-applications-to-sap-btp-cloud-foundry-environment/).\n\n## Requirements\n- Access to a SAP BTP subaccount (trial is sufficient)\n- Cloud foundry environment provisioned\n- Launchpad, Workzone, or comparable subscription with managed approuter functionality\n- Quota for the HTML5 Application Repository Service\n- Developer-Access to a CF Space\n- SAP Business Application Studio Subscription or comparable local IDE like VSCode\n- CF CLI \u0026 Node available locally on your machine or in BAS dev space\n\n## Build Steps\nRun the mbt build command with either of the mta.yaml files either directly or via the npm scripts in the root package.json:\n- mbt build -p=cf -s=./_build_standalone -t=../mta_archives\n- mbt build -p=cf -s=./_build_managed -t=../mta_archives\n\nMore info: https://sap.github.io/cloud-mta-build-tool/usage/\n\n### Standalone mta\n- This will generate an mtar that includes a standalone approuter that will be deployed together with the html5 module\n- This way you have full control of your approuter\n\n### Managed mta\n- This will generate an mtar which will leverage the managed approuter for running after deployment\n- This will only work if you have subscribed to a service that includes the managed approuter functionality (launchpad/portal/workzone)\n\n## Deploy Steps\nEnable cf deploy and cf undeploy commands (see also [multiapps-cli-plugin](https://github.com/cloudfoundry/multiapps-cli-plugin))\n- cf install-plugin multiapps\n\nLogin to your preferred BTP Cloud Foundry Space \u0026 deploy the MTAR archives\n- cf login\n- cf deploy ./mta_archives/ui5-standalone_1.0.0.mtar -f\n- cf deploy ./mta_archives/ui5-managed_1.0.0.mtar -f\n\nIn case of undeploy, you can undeploy the mta projects completely using:\n- cf undeploy ui5-standalone --delete-services --delete-service-keys\n- cf undeploy ui5-managed --delete-services --delete-service-keys\n\n## After Deployment\n### Verify service instances and application\nMake sure that all service instances and the cf application for the standalone scenario have been deployed successfully\n\u003cimg width=\"745\" alt=\"\" src=\"https://user-images.githubusercontent.com/7225881/198842721-d778ec3c-3554-43b6-a816-c7e02461f1f8.png\"\u003e\n\n### Verify html5 app content in html5 application repository\nMake sure that the html5 module content has been uploaded successfully in the html5 app repo host service instance\n- cf html5-list \u0026 cf html5-info\n\u003cimg width=\"954\" alt=\"\" src=\"https://user-images.githubusercontent.com/7225881/198842691-d98165f0-ab18-4ff4-8f4d-bdf1439b0bca.png\"\u003e\n\nMore info: https://sap.github.io/cf-html5-apps-repo-cli-plugin/\n\n### Authorize\n- map the generated user role templates to a role collection and assign it to your endusers\n\u003cimg width=\"805\" alt=\"\" src=\"https://user-images.githubusercontent.com/7225881/198842657-9e5a4867-d863-450c-a31d-e7f3b818205d.png\"\u003e\n\n### Execute\nrun the app either via\n- the custom route of the approuter (standalone) \n- the html5 applications tab on the left (managed - requires a a managed approuter e.g. from launchpad service)\n\n## Further Topics\n### Testing the app within BAS\n- Navigate to the html5module folder and execute npm run start\n- The ui5.yaml is used to proxy the requests via pathmapping (substitutes the xs-app files)\n- (Needs to be maintained on same subaccount as BAS instance - see comments in ui5.yaml)\n\n## How to obtain support\n[Create an issue](https://github.com/SAP-samples/\u003crepository-name\u003e/issues) in this repository if you find a bug or have questions about the content.\n \nFor additional support, [ask a question in SAP Community](https://answers.sap.com/questions/ask.html).\n\n## Contributing\nIf 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/).\n\n## Code of Conduct\nThe [SAP-samples CoC](https://github.com/SAP-samples/.github/blob/main/CODE_OF_CONDUCT.md) applies.\n\n## License\nCopyright (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.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsap-samples%2Fui5-deployments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsap-samples%2Fui5-deployments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsap-samples%2Fui5-deployments/lists"}