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!
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.
Run the following commands to test or develop this project:
- 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)
- Clone the repository and navigate into it
git clone https://github.com/UI5Lab/UI5Lab-browser
cd UI5Lab-browser- Install all npm dependencies (also installs all bower dependencies)
npm install- Run npm start to a local server (have a look into
Gruntfile.jsto see all the tasks).
npm start- Open the browser with the following URL: http://localhost:8080/test-resources/ui5lab/browser/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 UI5Lab-central project for more details
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:
-
Maintain the package.json file and increase the version number
-
Run grunt build to create a library preload and the CSS theme build for your library artifacts. Everything (minified and unminified sources) will be created in the
distfolder, ready to be published and consumed by other projects
grunt build- 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 publishNote: Official UI5Lab packages have to be published with the user
ui5lab, if you do not have permission ask a member the UI5Lab core team
- 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
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.
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.io.
The UI5Lab Community