Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): add community extensions page #5707

Merged
merged 1 commit into from
Jul 16, 2020
Merged

feat(docs): add community extensions page #5707

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 92 additions & 0 deletions docs/site/Community-extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
lang: en
title: 'Community extensions'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI, Extensions
sidebar: lb4_sidebar
permalink: /doc/en/lb4/Community-extensions.html
---

In addition to the extensions that LoopBack provides and maintains, there are a
number of extensions created by the open source community.

dhmlau marked this conversation as resolved.
Show resolved Hide resolved
To create a LoopBack extension, see
[Extending LoopBack 4 documentation page](https://loopback.io/doc/en/lb4/Extending-LoopBack-4.html)
for details. It is recommended to use the
[extension generator](https://loopback.io/doc/en/lb4/Extension-generator.html)
to scaffold a new extension.

The following table lists some of the community extensions. See
[npmjs.org](https://www.npmjs.com/search?q=loopback4%20extension) for a complete
list.

{% include warning.html content="The extensions listed here are not supported by the LoopBack team; they are maintained by the LoopBack community and are listed here for convenience."%}

## General

<table>
<thead>
<tr>
<th width="160">Extension</th>
<th width="280">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="https://www.npmjs.com/package/loopback4-soft-delete">loopback4-soft-delete</a></td>
<td>Used for soft-deletes in a multi-tenant application</td>
dhmlau marked this conversation as resolved.
Show resolved Hide resolved
</tr>
<tr>
<td><a href="https://www.npmjs.com/package/loopback4-helmet">loopback4-helmet</a></td>
<td>Integrate <a href="https://helmetjs.github.io/">helmetjs</a> in LoopBack applications</td>
</tr>
<tr>
<td><a href="https://www.npmjs.com/package/loopback4-ratelimiter">loopback4-ratelimiter</a></td>
<td>Provide rate limiting in LoopBack applications</td>
</tr>
<tr>
<td><a href="https://www.npmjs.com/package/loopback4-notifications">loopback4-notifications</a></td>
<td>Add different notification mechanisms vis-à-vis, Push, SMS, Email, to any LoopBack 4 based REST API application or microservice</td>
</tr>
<tr>
<td><a href="https://www.npmjs.com/package/loopback4-s3">loopback4-s3</a></td>
<td>Integrate AWS S3 in LoopBack applications</td>
</tr>
<tr>
<td><a href="https://www.npmjs.com/package/loopback-component-history">loopback-component-history</a></td>
<td>Soft create, edit, delete models, saving history of changes</td>
</tr>
<tr>
<td><a href="https://www.npmjs.com/package/loopback-component-filter">loopback-component-filter</a></td>
<td>Filter models in repository layer, using an async function</td>
</tr>
</tbody>
</table>

## Authentication and authorization related extensions

<table>
<thead>
<tr>
<th width="160">Extension</th>
<th width="280">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="https://www.npmjs.com/package/loopback4-authentication">loopback4-authentication</a></td>
<td>Provide support for five passport based strategies</td>
</tr>
<tr>
<td><a href="https://www.npmjs.com/package/loopback4-authorization">loopback4-authorization</a></td>
<td>Implement authorization using simple string based permissions</td>
</tr>
<tr>
<td><a href="https://www.npmjs.com/package/loopback-component-crud">loopback-component-crud</a></td>
<td>Generic CRUD controller mixin, supports authentication, nested authorization(cascade)</td>
</tr>
<tr>
<td><a href="https://www.npmjs.com/package/loopback-component-authorization">loopback-component-authorization</a></td>
<td>Implement HRBAC authorization</td>
</tr>
</tbody>
<table>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add instructions on how can extension authors contribute their extensions to our list. Feel free to open a follow-up pull request for that.

You can inspire in our existing docs for contributing LB3 extensions: https://loopback.io/doc/en/community/How-to-add-a-project.html

4 changes: 4 additions & 0 deletions docs/site/sidebars/lb4_sidebar.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -858,6 +858,10 @@ children:
url: Testing-your-extension.html
output: 'web, pdf'

- title: 'Community extensions'
url: Community-extensions.html
output: 'web, pdf'

- title: 'Contribute to LoopBack 4'
url: code-contrib-lb4.html
output: 'web, pdf'
Expand Down