Download or clone this repository:
git clone [email protected]:pulseshift/openui5-gulp-starter-kit.git
Please ensure that you have installed node and yarn before you continue.
Install dependencies:
yarn
Start developing: Will build all resources start watcher task and start a HTTP server
yarn start
The app should open in your browser automatically, otherwise open: http://localhost:3000
Info: To get a more detailed logging, just use yarn start:verbose instead.
OpenUI5 Starter Kit is an opinionated to-do app example as template for OpenUI5 web development. Containing a modern build infrastructure, tools and a set of best practices for building a great development experience and helping you to stay productive.
A solid starting point for both professionals and newcomers to OpenUI5.
Please see also the seperated branches of this project, at the time these are:
- nwabap is the OpenUI5 Starter Kit branch which allows a developer to upload SAPUI5/OpenUI5 sources into a SAP NetWeaver ABAP system as part of the Gulp task chain
| Feature | Summary |
|---|---|
| ❤ ES6/ES7 via Babel 6.0 | Compile ES6/ES7 into ES5 (supported by most browsers) with ease, bringing support for next generation JavaScript, today. |
| Less support | Compile Less into CSS with ease, bringing support for variables, mixins and more. |
| Consistent code formatting | Prettier is an awesome opinionated code formatter used in many well known projects like Webpack, Babel or React. In this starter kit prettier re-formats your files that are marked as "staged" via git add before you commit. We recommend to add also prettier as integration to your Editor during development. |
| Built-in HTTP Server | An extendable built-in server for previewing your site locally while you develop and iterate and the option to add API endpoints via a proxy to get around Access-Control-Allow-Origin (CORS) errors. |
| Live Browser Reloading | Reload the browser in real-time anytime an edit is made without the need for an extension. (Run yarn start and edit your files) |
| Cross-device Synchronization | Synchronize clicks, scrolls, forms and live-reload across multiple devices as you edit your project. Powered by BrowserSync. (Run yarn start and open up the IP provided on other devices on your network) |
| Production ready builds | Pre-configured build pipeline to create optimized assets, UI5 pre-loads etc. just as you would expect from a state of the art build process. All kind of UI5 asets are supported: App Components, Custom Themes, Control Libraries and non-UI5 assets roots. The structure of your project can be configured in your package.json in section ui5. A detailed documentation of all options will follow soon. |
| ⚡️ Reliable UI5 Cache-Buster | Ensure your users are always enjoying the latest version of your app. OpenUI5 provides only solutions proprietary for SAP Gateway and SAP Cloud Platform. In this project, we added a more reliable mechanism that is open source and available for any environment. But much more important, with our Gulp build script, it works right out of the box. |
| A Hackable UI5 Build Process | Define in your package.json the source of your OpenUI5 library. Supported options are online CDN link, download URL of a prebuild library or a GitHub release link of OpenUI5. In all cases, the build process will handle the download, unzip and OpenUI5 build task by its own. Lean back and wait relaxed. |
| Pre-configured linter (ESLint) | ESLint is a pluggable linting utility for JavaScript. It is pre-configured to work reliable and hand in hand with babel and prettier. |
| RealFaviconGenerator support | RealFaviconGenerator is a module that auto generates favicons for all platforms based on a single master image. |
| ⚙️ Gzip and Brotli compression ready build | Pre-compression of the two most common and modern compression algorithms to minify the used bandwith (your HTTP server must support static serve of gzip and/or brotli files – yarn start:dist is able to serve the compressed files). |
| 🤘 Support for external ui5 npm modules | Support for external npm ui5 libraries added via yarn add **npm-module-name** --dev. Ensure the module name matches the exposed name of the external lib and that you point to the prebuild dist folder. (Auto-build of non prebuild modules is in BETA). |
Start build:
Will create a dist directory in your project root.
yarn build
Afterwards, the production app build can be tested by run yarn start:dist. The app should open in your browser automatically, otherwise open: http://localhost:3000
Info: To get a more detailed logging, just use yarn build:verbose instead.
Attention: comments are only for explanation, tehy can't be used in package.json.
{
// path to an handlebars file used to create the index.html file of this project
"main": "src/index.hbs",
// define a master favicon and generate all x-browser fav-icons at once
"favicon": {
"src": "src/assets/favicon/master.png"
},
// custom section with settings required for the build process
"ui5": {
// tite name of the index.html
"indexTitle": "UI5 Todo App",
// build settings
"build": {
// turn cache buster on to invalidate the users browser cache automatically for changed files
"cacheBuster": true,
// turn on compression to minify file size and bandwith of HTTP server (options: boolean or list of compression algorithms)
"compression": ["gzip", "brotli"]
},
// key of the selected UI5 library source (must be available in section ui5.srcLinks)
"src": "cdn",
// map of different sources for the UI5 library, only one can be selected to be used in the UI5-bootstrap of the index.html
"srcLinks": {
"cdn": {
// URL or relative path to the UI5 library (it is possible to pass properties in the URL via handlebars notation)
"url": "https://openui5.hana.ondemand.com/{{version}}/resources/sap-ui-core.js",
// flag whether or not the UI5 library at the defined URL is a prebuild or not
"isPrebuild": true,
// flag whether or not the UI5 library at the defined URL must be unarchived before further processing
"isArchive": false,
// list of further attributes that can be used as properties for the URL creation
"version": "1.50.8"
}
},
// target path for 3rd party npm dependencies
// e.g. moment.js can then be required via sap.ui.define(['apps/libs/moment']function(moment){ ... });
"vendor": {
"name": "app.libs",
"path": "src/libs"
},
// name of the selected UI5 theme for your bootstrap
"theme": "sap_belize",
// list with custom ui5-component/app roots consisting of a 'name' and a 'path'
"apps": [{
"name": "app.todo",
"path": "src/openui5-todo-app",
// abab BSP destination of your app
"nwabapDestination": {
"package": "$TMP",
"bspcontainer": "ZZ_UI5_LOCAL",
"bspcontainer_text": "UI5 upload local objects",
"langauage": "EN"
}
}],
// list with custom ui5-library roots consisting of a 'name' and a 'path'
"libraries": [
{
"name": "my.control.lib",
"path": "src/commons/ui5-controls"
},{
// support for external npm ui5 libraries added via 'yarn add xyz --dev' (since starter-kit v0.3.2)
// ensure the module name matches the exposed name of the external lib
"name": "npm.control.lib",
"path": "node_modules/dist/ui5-controls",
"prebuild": true
}],
// list with custom ui5-theme roots consisting of a 'name' and a 'path'
"themes": [{
"name": "my_custom_theme_name",
"path": "src/commons/ui5-themes"
}],
// list with non-ui5 resource roots consisting of a 'name' and a 'path'
"assets": [{
"name": "commons.images",
"path": "src/commons/img"
}]
},
// all dependencies installed via 'yarn add ...' will be made available for your UI5 app without need of editing the manifest.json
"dependencies": {
// libraries are automatically loaded into the path defined at section ui5.vendor.path,
// they can be required in your controler via the name defined in ui5.vendor.name
}
}Contributions, questions and comments are all welcome and encouraged.
Check our current issues or, if you have something in mind how to make it better, create your own issue. We would be happy to discuss how they can be solved.
Here is a brief overview on what we are working right know and what will follow, soon. We are interested to hear your opinion on what should follow next.
Current idea backlog (unordered):
- Add a further project based on Webpack
- Add Facebooks flow type system with help of vagrant to support Windows machines, too
- Unit test and browser test framework
- Documentation generation via JSDoc
- Optimized OpenUI5 library modules (containing only these controls you used)
- I18N helper integration
- Detailed README for all package.json (section ui5) configuration options
Rocket logo created by Hopkins from the Noun Project CC BY 3.0 US.
This project is licensed under the MIT license. Copyright 2017 PulseShift GmbH