Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 2.66 KB

README.md

File metadata and controls

77 lines (55 loc) · 2.66 KB
Raw

UI5 serve static middleware

👋 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, enabling to serve static resources.

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-servestatic --save-dev

Configuration options (in $yourapp/ui5.yaml)

  • debug: boolean debug logging
  • rootPath: string the root path to the static resources on your system (absolute or relative path to app)
  • npmPackagePath: string the npm package path pointing to the root path for the static resources (e.g. "@scope/packageName/path", "packageName/path", "packageName")

Hints:

  • If a rootPath is given, the npmPackagePath will be ignored
  • Values for rootPath or npmPackagePath can be also provided by environment variables by using the prefix env. e.g. rootPath: env.MY_ENV_VAR

Usage

  1. Define the dependency in $yourapp/package.json:
"devDependencies": {
    // ...
    "ui5-middleware-servestatic": "*"
    // ...
}
  1. configure it in $yourapp/ui5.yaml:
server:
  customMiddleware:
  - name: ui5-middleware-servestatic
    afterMiddleware: compression
    mountPath: /resources
    configuration:
      rootPath: "/Users/Me/upkg/sapui5-runtime-1.70/resources"

Example which uses Environment Variables from .env file

server:
  customMiddleware:
  - name: ui5-middleware-servestatic
    afterMiddleware: compression
    mountPath: /resources
    configuration:
      rootPath: ${env.SAPUI5_SDK_1_60__RESOURCES}

How it works

The middleware integrates serve-static to serve static resources from a specified rootPath.

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 a beer or buy @pmuessig a coke when you see them.