Skip to content

Commit 993a97f

Browse files
nabdelgadirbajtos
nabdelgadir
and
bajtos
committed
feat: add booter-lb3app package
Co-authored-by: Miroslav Bajtoš <mbajtoss@gmail.com>
1 parent 469830f commit 993a97f

33 files changed

+3483
-0
lines changed

‎CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
packages/authentication/* @bajtos @raymondfeng
1010
packages/boot/* @raymondfeng @hacksparrow
11+
packages/booter-lb3app/* @bajtos @nabdelgadir
1112
packages/build/* @bajtos @raymondfeng
1213
packages/http-caching-proxy/* @bajtos
1314
packages/http-server/* @hacksparrow @bajtos

‎docs/apidocs.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ <h3>List of packages</h3>
1919
<ul>
2020
<li><a href="./authentication.html">@loopback/authentication</a></li>
2121
<li><a href="./boot.html">@loopback/boot</a></li>
22+
<li><a href="./booter-lb3app.html">@loopback/booter-lb3app</a></li>
2223
<li><a href="./context.html">@loopback/context</a></li>
2324
<li><a href="./core.html">@loopback/core</a></li>
2425
<li><a href="./http-caching-proxy.html">@loopback/http-caching-proxy</a></li>

‎docs/site/Boot-and-Mount-a-LoopBack-3-application.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
lang: en
3+
title: 'Boot and Mount a LoopBack 3 Application'
4+
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3
5+
layout: readme
6+
source: loopback-next
7+
file: packages/booter-lb3app/README.md
8+
sidebar: lb4_sidebar
9+
permalink: /doc/en/lb4/Boot-and-Mount-a-LoopBack-3-application.html
10+
---

‎docs/site/MONOREPO.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ The [loopback-next](https://github.com/strongloop/loopback-next) repository uses
88
| Package | npm | Description |
99
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1010
| [authentication](https://github.com/strongloop/loopback-next/tree/master/packages/authentication) | @loopback/authentication | A component for authentication support |
11+
| [booter-lb3app](https://github.com/strongloop/loopback-next/tree/master/packages/booter-lb3app) | @loopback/booter-lb3app | A booter component for LoopBack 3 applications to expose their REST API via LoopBack 4. |
1112
| [boot](https://github.com/strongloop/loopback-next/tree/master/packages/boot) | @loopback/boot | Convention based Bootstrapper and Booters |
1213
| [build](https://github.com/strongloop/loopback-next/tree/master/packages/build) | @loopback/build | A set of common scripts and default configurations to build LoopBack 4 or other TypeScript modules |
1314
| [cli](https://github.com/strongloop/loopback-next/tree/master/packages/cli) | @loopback/cli | CLI for LoopBack 4 |

‎docs/site/sidebars/lb4_sidebar.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,10 @@ children:
262262
url: Loopback-component-authorization.html
263263
output: 'web, pdf'
264264

265+
- title: 'Boot and Mount a LoopBack 3 Application'
266+
url: Boot-and-Mount-a-LoopBack-3-application.html
267+
output: 'web, pdf'
268+
265269
- title: 'Calling other APIs'
266270
url: Calling-other-APIs-and-web-services.html
267271
output: 'web, pdf'

‎greenkeeper.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
"examples/todo/package.json",
1616
"packages/authentication/package.json",
1717
"packages/boot/package.json",
18+
"packages/booter-lb3app/package.json",
1819
"packages/build/package.json",
1920
"packages/cli/package.json",
2021
"packages/context/package.json",

‎packages/booter-lb3app/.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
package-lock=true

‎packages/booter-lb3app/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file.
4+
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

‎packages/booter-lb3app/LICENSE

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Copyright (c) IBM Corp. 2019. All Rights Reserved.
2+
Node module: @loopback/booter-lb3app
3+
This project is licensed under the MIT License, full text below.
4+
5+
--------
6+
7+
MIT license
8+
9+
Permission is hereby granted, free of charge, to any person obtaining a copy
10+
of this software and associated documentation files (the "Software"), to deal
11+
in the Software without restriction, including without limitation the rights
12+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13+
copies of the Software, and to permit persons to whom the Software is
14+
furnished to do so, subject to the following conditions:
15+
16+
The above copyright notice and this permission notice shall be included in
17+
all copies or substantial portions of the Software.
18+
19+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25+
THE SOFTWARE.

‎packages/booter-lb3app/README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# @loopback/booter-lb3app
2+
3+
Boot a LoopBack 3 application and expose its REST API via LoopBack 4.
4+
5+
## Overview
6+
7+
The `@loopback/booter-lb3app` package provides a way for LoopBack 3 developers
8+
to boot their LoopBack 3 application, convert the application's Swagger spec
9+
into OpenAPI v3, and then mount the application, including its spec, onto a
10+
target LoopBack 4 application.
11+
12+
## Installation
13+
14+
```sh
15+
npm install --save @loopback/booter-lb3app
16+
```
17+
18+
## Basic use
19+
20+
Import the component at the top of your `src/application.ts` file.
21+
22+
```ts
23+
import {Lb3AppBooterComponent} from '@loopback/booter-lb3app';
24+
```
25+
26+
Register the component in Application's constructor:
27+
28+
```ts
29+
this.component(Lb3AppBooterComponent);
30+
```
31+
32+
## Contributions
33+
34+
- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md)
35+
- [Join the team](https://github.com/strongloop/loopback-next/issues/110)
36+
37+
## Tests
38+
39+
Run `npm test` from the root folder.
40+
41+
## Contributors
42+
43+
See
44+
[all contributors](https://github.com/strongloop/loopback-next/graphs/contributors).
45+
46+
## License
47+
48+
MIT

0 commit comments

Comments
 (0)