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.
Overview
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.
Other branches
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
Features
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).
请发表评论