-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: updated README.md for UI5 Tooling V3 release (#777)
- Loading branch information
1 parent
c03bc0e
commit 65287fa
Showing
26 changed files
with
290 additions
and
306 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,19 @@ | ||
# ui5-middleware-cap | ||
|
||
> :wave: 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. | ||
The `ui5-middleware-cap` is a UI5 tooling middleware which enables the integration of a CAP server into the UI5 development server via the CAP server express middlewares. In addition to the middleware the CAP server project needs to be added as dependency so that the server is detected and attached properly. The pre-defined routes in the CAP server are reused. | ||
|
||
> :construction: **Note** | ||
> This middleware is still work in progress and not final yet! | ||
## Prerequisites | ||
|
||
- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30)) | ||
|
||
> :warning: **UI5 Tooling Compatibility** | ||
> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3! | ||
## Usage | ||
|
||
Add a `devDependency` to the `ui5-middleware-cap`: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,16 @@ | ||
# UI5 middleware for CF destinations | ||
|
||
> :wave: 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](https://github.com/SAP/ui5-server), making `destinations` configured in SAP CF available for local development. | ||
|
||
## Prerequisites | ||
|
||
- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30)) | ||
|
||
> :warning: **UI5 Tooling Compatibility** | ||
> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3! | ||
## Install | ||
|
||
```bash | ||
|
@@ -62,18 +71,9 @@ This sets the body size limit. If the body size is larger than the specified (or | |
// ... | ||
"ui5-middleware-cfdestination": "*" | ||
// ... | ||
}, | ||
"ui5": { | ||
"dependencies": [ | ||
// ... | ||
"ui5-middleware-cfdestination", | ||
// ... | ||
] | ||
} | ||
``` | ||
|
||
> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies. | ||
2. configure it in `$yourapp/ui5.yaml`: | ||
|
||
```yaml | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,16 @@ | ||
# UI5 middleware for syncing interactions across browsers | ||
|
||
> :wave: 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](https://github.com/SAP/ui5-server), syncing interactions between different browsers, hopefully somewhat easing manual testing :) | ||
|
||
## Prerequisites | ||
|
||
- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30)) | ||
|
||
> :warning: **UI5 Tooling Compatibility** | ||
> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3! | ||
## Install | ||
|
||
```bash | ||
|
@@ -30,18 +39,9 @@ show connected browsers | |
// ... | ||
"ui5-middleware-iasync": "*" | ||
// ... | ||
}, | ||
"ui5": { | ||
"dependencies": [ | ||
// ... | ||
"ui5-middleware-iasync", | ||
// ... | ||
] | ||
} | ||
``` | ||
|
||
> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies. | ||
2. configure it in `$yourapp/ui5.yaml`: | ||
|
||
```yaml | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,16 @@ | ||
# UI5 middleware for delivering a welcome/start/'index' page to the client | ||
|
||
> :wave: 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](https://github.com/SAP/ui5-server), delivering the `$index.html` of choice (instead of the directory listing). | ||
|
||
## Prerequisites | ||
|
||
- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30)) | ||
|
||
> :warning: **UI5 Tooling Compatibility** | ||
> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3! | ||
## Install | ||
|
||
```bash | ||
|
@@ -23,18 +32,9 @@ npm install ui5-middleware-index --save-dev | |
// ... | ||
"ui5-middleware-index": "*" | ||
// ... | ||
}, | ||
"ui5": { | ||
"dependencies": [ | ||
// ... | ||
"ui5-middleware-index", | ||
// ... | ||
] | ||
} | ||
``` | ||
|
||
> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies. | ||
2. configure it in `$yourapp/ui5.yaml`: | ||
|
||
```yaml | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,16 @@ | ||
# UI5 middleware for live compiling less files | ||
|
||
> :wave: 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](https://github.com/SAP/ui5-server), live compiling less files. | ||
|
||
## Prerequisites | ||
|
||
- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30)) | ||
|
||
> :warning: **UI5 Tooling Compatibility** | ||
> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3! | ||
## Install | ||
|
||
```bash | ||
|
@@ -22,18 +31,9 @@ npm install ui5-middleware-livecompileless --save-dev | |
// ... | ||
"ui5-middleware-livecompileless": "*" | ||
// ... | ||
}, | ||
"ui5": { | ||
"dependencies": [ | ||
// ... | ||
"ui5-middleware-livecompileless", | ||
// ... | ||
] | ||
} | ||
``` | ||
|
||
> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies. | ||
2. configure it in `$yourapp/ui5.yaml`: | ||
|
||
```yaml | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,16 @@ | ||
# UI5 middleware for live reloading `webapp` sources on change | ||
|
||
> :wave: 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](https://github.com/SAP/ui5-server), doing a live reload when files inside `$yourapp` change, e.g. on save. | ||
|
||
## Prerequisites | ||
|
||
- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30)) | ||
|
||
> :warning: **UI5 Tooling Compatibility** | ||
> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3! | ||
## Install | ||
|
||
```bash | ||
|
@@ -33,18 +42,9 @@ npm install ui5-middleware-livereload --save-dev | |
// ... | ||
"ui5-middleware-livereload": "*" | ||
// ... | ||
}, | ||
"ui5": { | ||
"dependencies": [ | ||
// ... | ||
"ui5-middleware-livereload", | ||
// ... | ||
] | ||
} | ||
``` | ||
|
||
> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies. | ||
2. configure it in `$yourapp/ui5.yaml`: | ||
|
||
```yaml | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
# UI5 onelogin middleware | ||
|
||
> :wave: 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](https://github.com/SAP/ui5-server), enabling a generic login support. | ||
|
||
The middleware will on first request try to login with the provided credentials and save the cookie for further requests. This uses playwright in a headless mode to run the login process. | ||
|
@@ -9,6 +11,13 @@ This has been tested with Azure AD, Google, OpenAM and the SAP Gateway login pag | |
|
||
Merge requests with other login handlers are more than welcome via pull request. | ||
|
||
## Prerequisites | ||
|
||
- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30)) | ||
|
||
> :warning: **UI5 Tooling Compatibility** | ||
> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3! | ||
## Install | ||
|
||
```bash | ||
|
@@ -50,18 +59,9 @@ You can choose to just add the url and let the rest be prompted in the terminal | |
// ... | ||
"ui5-middleware-onelogin": "*" | ||
// ... | ||
}, | ||
"ui5": { | ||
"dependencies": [ | ||
// ... | ||
"ui5-middleware-onelogin", | ||
// ... | ||
] | ||
} | ||
``` | ||
|
||
> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies. | ||
2. configure it in `$yourapp/ui5.yaml`: | ||
|
||
```yaml | ||
|
@@ -79,4 +79,4 @@ server: | |
## License | ||
MIT | ||
This work is [dual-licensed](../../LICENSE) 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,16 @@ | ||
# UI5 serve static middleware | ||
|
||
> :wave: 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](https://github.com/SAP/ui5-server), enabling to serve static resources. | ||
|
||
## Prerequisites | ||
|
||
- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30)) | ||
|
||
> :warning: **UI5 Tooling Compatibility** | ||
> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3! | ||
## Install | ||
|
||
```bash | ||
|
@@ -22,18 +31,9 @@ npm install ui5-middleware-servestatic --save-dev | |
// ... | ||
"ui5-middleware-servestatic": "*" | ||
// ... | ||
}, | ||
"ui5": { | ||
"dependencies": [ | ||
// ... | ||
"ui5-middleware-servestatic", | ||
// ... | ||
] | ||
} | ||
``` | ||
|
||
> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies. | ||
2. configure it in `$yourapp/ui5.yaml`: | ||
|
||
```yaml | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,6 +2,13 @@ | |
|
||
Middleware for [ui5-server](https://github.com/SAP/ui5-server), enabling proxy support. | ||
|
||
## Prerequisites | ||
|
||
- Requires at least [`@ui5/[email protected]`](https://sap.github.io/ui5-tooling/v3/pages/CLI/) (to support [`specVersion: "3.0"`](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-version-30)) | ||
|
||
> :warning: **UI5 Tooling Compatibility** | ||
> All releases of this tooling extension using the major version `3.x.x` only support UI5 Tooling V3. Any previous release below version `3` (if available) also supports older versions of the UI5 Tooling. But it's strongly recommended to upgrade to UI5 Tooling V3! | ||
## Install | ||
|
||
```bash | ||
|
@@ -44,18 +51,9 @@ In general, use of environment variables or values set in a `.env` file will ove | |
// ... | ||
"ui5-middleware-simpleproxy": "*" | ||
// ... | ||
}, | ||
"ui5": { | ||
"dependencies": [ | ||
// ... | ||
"ui5-middleware-simpleproxy", | ||
// ... | ||
] | ||
} | ||
``` | ||
|
||
> As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the `ui5 > dependencies` array. In addition, once using the `ui5 > dependencies` array you need to list all UI5 tooling relevant dependencies. | ||
2. configure it in `$yourapp/ui5.yaml`: | ||
|
||
```yaml | ||
|
Oops, something went wrong.