Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 2.42 KB

README.md

File metadata and controls

63 lines (42 loc) · 2.42 KB
Raw

UI5 middleware for delivering a welcome/start/'index' page to the client

👋 This is a community project and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.

Middleware for ui5-server, delivering the $index.html of choice (instead of the directory listing).

Prerequisites

⚠️ UI5 Tooling Compatibility All releases of this tooling extension using the major version 3 require UI5 Tooling V3. Any previous releases below major version 3 (if available) also support older versions of the UI5 Tooling. But the usage of the latest UI5 Tooling is strongly recommended!

Install

npm install ui5-middleware-index --save-dev

Configuration options (in $yourapp/ui5.yaml)

  • debug: <boolean>, default: false
  • welcomeFile: <string>, default: index.html the file to redirect to when the root path / is requested
  • index: <string>, default: index.html deprecated file inside $yourapp to deliver for http://<host>:<port>/

Usage

  1. Define the dependency in $yourapp/package.json:
"devDependencies": {
    // ...
    "ui5-middleware-index": "*"
    // ...
}
  1. configure it in $yourapp/ui5.yaml:
server:
  customMiddleware:
  - name: ui5-middleware-index
    afterMiddleware: compression
    configuration:
      welcomeFile: "index_peter.html"

How it works

The middleware delivers the configured index HTML-file to the client if the FQDN + trailing slash / is requested in the browser.

Development

If you want to contribute to ui5-middleware-index, please use Prettier for code formatting/style and apply the rules from ./.prettierrc. Thanks 🙏!

License

This work is dual-licensed under Apache 2.0 and the Derived Beer-ware License. The official license will be Apache 2.0 but finally you can choose between one of them if you use this work.

When you like this stuff, buy @vobu, @stefanbeck3, github.com/margopolo a beer or buy @pmuessig a coke when you see them.