ui5lab-browser

What is it

UI5Lab is a community driven repository for UI5 Custom Control Libraries. It's purpose is to make it easy for everyone to share, retrieve and use UI5 Custom Controls. Contributions welcome!

UI5Lab-browser

This repository contains a browser to display custom libraries and control examples on the UI5Lab homepage. The app implemented in UI5 can also be used for testing control samples and previewing libraries during development. Have a look at our documentation for more details.

Setup

Run the following commands to test or develop this project:

1. Install node.js (get it from nodejs.org)

Note: If working behind a proxy, you need to configure it properly (HTTP_PROXY / HTTPS_PROXY / NO_PROXY environment variables)

1. Clone the repository and navigate into it:

git clone https://github.com/UI5Lab/UI5Lab-browser
cd UI5Lab-browser

1. Install all npm dependencies :

npm install

1. Run a local Web server with the ui5 tools for testing:

npm start

Note: Run npm install --global @ui5/cli if the ui5 command is not registered (for more information see ui5 tooling)

1. Open the browser with the following URL: http://localhost:8080/index.html

Note: To test the browser, one or more libraries should be defined as a dependency and registered in the libraries.json file. See the gh-pages branch of UI5Lab-central project for a live example

Publishing to npm

The library project and the central project reference the browser via npm module. In order to publish a new version to npm follow these steps:

1. Maintain the package.json file and increase the version number

2. Run the ui5 build tools to create a library preload and the CSS theme build for your library artifacts. Everything (minified and unminified sources) will be created in the dist folder, ready to be published and consumed by other projects

npm run build

1. Publish your package to npm, be sure to include only the metadata and the dist folder to keep the package size small (see .npmignore file for details)

npm publish

Note: Official UI5Lab packages have to be published with the user ui5lab, if you do not have permission ask a member the UI5Lab core team

Directions

• Homepage - the single point of entry for UI5Lab
• Documentation - project overview and tutorials
• Browser - all UI5Lab libraries and examples
• Demo - an example app consuming simple UI5Lab controls

Troubleshooting

Issues can be created either in this repository or in any of the contributor repositories depending on where the error came from. Be sure to include enough details and context to reproduce the issue and follow up with you.

Contact

We organize this project in Slack Channel #UI5Lab. If you are interested in what we do and discuss, join with this invitation link or visit the homepage https://ui5lab.github.io/UI5Lab-central/.

The UI5Lab Community