@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
92 lines (86 loc) • 36.5 kB
Markdown
<!-- Do not edit this file. It is automatically generated by update-monorepo-file script -->
# Monorepo overview
The [loopback-next](https://github.com/loopbackio/loopback-next) repository uses
[lerna](https://lernajs.io/) to manage multiple packages for LoopBack 4.
Please run the following command to update packages information after adding new
one in the monorepo: `npm run update-monorepo-file`
| Package | npm | Description |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [acceptance/extension-logging-fluentd](https://github.com/loopbackio/loopback-next/tree/master/acceptance/extension-logging-fluentd) | _(private)_ | Acceptance test for `@loopback/logging` with fluentd |
| [acceptance/repository-cloudant](https://github.com/loopbackio/loopback-next/tree/master/acceptance/repository-cloudant) | _(private)_ | Acceptance tests for `@loopback/repository` + `loopback-connector-cloudant` |
| [acceptance/repository-mongodb](https://github.com/loopbackio/loopback-next/tree/master/acceptance/repository-mongodb) | _(private)_ | Acceptance tests for `@loopback/repository` + `loopback-connector-mongodb` |
| [acceptance/repository-mysql](https://github.com/loopbackio/loopback-next/tree/master/acceptance/repository-mysql) | _(private)_ | Acceptance tests for `@loopback/repository` + `loopback-connector-mysql` |
| [acceptance/repository-postgresql](https://github.com/loopbackio/loopback-next/tree/master/acceptance/repository-postgresql) | _(private)_ | Acceptance tests for `@loopback/repository` + `loopback-connector-postgresql` |
| [benchmark](https://github.com/loopbackio/loopback-next/tree/master/benchmark) | _(private)_ | Benchmarks measuring performance of our framework. |
| [bodyparsers/rest-msgpack](https://github.com/loopbackio/loopback-next/tree/master/bodyparsers/rest-msgpack) | @loopback/rest-msgpack | Body parser to handle MessagePack requests in LoopBack 4. |
| [docs](https://github.com/loopbackio/loopback-next/tree/master/docs) | @loopback/docs | Documentation files rendered at [https://loopback.io](https://loopback.io) |
| [examples/access-control-migration](https://github.com/loopbackio/loopback-next/tree/master/examples/access-control-migration) | @loopback/example-access-control-migration | Tutorial example on how to migrate the access control example with LoopBack 4. |
| [examples/binding-resolution](https://github.com/loopbackio/loopback-next/tree/master/examples/binding-resolution) | @loopback/example-binding-resolution | An example application to demonstrate binding resolution and dependency injection within a context hierarchy |
| [examples/context](https://github.com/loopbackio/loopback-next/tree/master/examples/context) | @loopback/example-context | Standalone examples to illustrate features provided by /context |
| [examples/express-composition](https://github.com/loopbackio/loopback-next/tree/master/examples/express-composition) | @loopback/example-express-composition | LoopBack 4 REST API on Express |
| [examples/file-transfer](https://github.com/loopbackio/loopback-next/tree/master/examples/file-transfer) | @loopback/example-file-transfer | Example application for file upload/download with LoopBack 4 |
| [examples/graphql](https://github.com/loopbackio/loopback-next/tree/master/examples/graphql) | @loopback/example-graphql | GraphQL Example Application |
| [examples/greeter-extension](https://github.com/loopbackio/loopback-next/tree/master/examples/greeter-extension) | @loopback/example-greeter-extension | An example showing how to implement the extension point/extension pattern using LoopBack 4 |
| [examples/greeting-app](https://github.com/loopbackio/loopback-next/tree/master/examples/greeting-app) | @loopback/example-greeting-app | An example greeting application for LoopBack 4 |
| [examples/hello-world](https://github.com/loopbackio/loopback-next/tree/master/examples/hello-world) | @loopback/example-hello-world | A simple hello-world Application using LoopBack 4 |
| [examples/lb3-application](https://github.com/loopbackio/loopback-next/tree/master/examples/lb3-application) | @loopback/example-lb3-application | Tutorial example on how to add existing an LB3 application to a LB4 project |
| [examples/log-extension](https://github.com/loopbackio/loopback-next/tree/master/examples/log-extension) | @loopback/example-log-extension | An example showing how to write a complex log extension for LoopBack 4 |
| [examples/metrics-prometheus](https://github.com/loopbackio/loopback-next/tree/master/examples/metrics-prometheus) | @loopback/example-metrics-prometheus | An example to illustrate metrics provided by /metrics and Prometheus |
| [examples/multi-tenancy](https://github.com/loopbackio/loopback-next/tree/master/examples/multi-tenancy) | @loopback/example-multi-tenancy | An example to illustrate how to enable multi-tenancy with LoopBack's IoC and DI container |
| [examples/passport-login](https://github.com/loopbackio/loopback-next/tree/master/examples/passport-login) | @loopback/example-passport-login | An example to demonstrate authentication with passport strategies |
| [examples/rest-crud](https://github.com/loopbackio/loopback-next/tree/master/examples/rest-crud) | @loopback/example-rest-crud | An example showing how to use /rest-crud to define default repository and controller classes |
| [examples/rpc-server](https://github.com/loopbackio/loopback-next/tree/master/examples/rpc-server) | @loopback/example-rpc-server | An example RPC server and application to demonstrate the creation of your own custom server |
| [examples/soap-calculator](https://github.com/loopbackio/loopback-next/tree/master/examples/soap-calculator) | @loopback/example-soap-calculator | A tutorial demonstrating integration SOAP webservice with LoopBack 4 |
| [examples/socketio](https://github.com/loopbackio/loopback-next/tree/master/examples/socketio) | @loopback/example-socketio | This is an example for spinning up socket server. |
| [examples/todo](https://github.com/loopbackio/loopback-next/tree/master/examples/todo) | @loopback/example-todo | Tutorial example on how to build an application with LoopBack 4 |
| [examples/todo-jwt](https://github.com/loopbackio/loopback-next/tree/master/examples/todo-jwt) | @loopback/example-todo-jwt | A modified Todo tutorial how to build an application with JWT authentication and LoopBack 4 |
| [examples/todo-list](https://github.com/loopbackio/loopback-next/tree/master/examples/todo-list) | @loopback/example-todo-list | Continuation of the todo example using relations in LoopBack 4. |
| [examples/validation-app](https://github.com/loopbackio/loopback-next/tree/master/examples/validation-app) | @loopback/example-validation-app | An example demonstrating how to add validation in a LoopBack 4 application |
| [examples/webpack](https://github.com/loopbackio/loopback-next/tree/master/examples/webpack) | @loopback/example-webpack | An example to bundle /core using webpack |
| [extensions/apiconnect](https://github.com/loopbackio/loopback-next/tree/master/extensions/apiconnect) | @loopback/apiconnect | An extension for IBM API Connect |
| [extensions/authentication-jwt](https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt) | @loopback/authentication-jwt | Extension for the prototype of JWT authentication |
| [extensions/authentication-passport](https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-passport) | @loopback/authentication-passport | A package creating adapters between the passport module and /authentication |
| [extensions/context-explorer](https://github.com/loopbackio/loopback-next/tree/master/extensions/context-explorer) | @loopback/context-explorer | Visualize context hierarchy, bindings, configurations, and dependencies |
| [extensions/cron](https://github.com/loopbackio/loopback-next/tree/master/extensions/cron) | @loopback/cron | Schedule tasks using cron-like syntax |
| [extensions/graphql](https://github.com/loopbackio/loopback-next/tree/master/extensions/graphql) | @loopback/graphql | LoopBack's graphql integration |
| [extensions/health](https://github.com/loopbackio/loopback-next/tree/master/extensions/health) | @loopback/health | An extension exposes health check related endpoints with LoopBack 4 |
| [extensions/logging](https://github.com/loopbackio/loopback-next/tree/master/extensions/logging) | @loopback/logging | An extension exposes logging for Winston and Fluentd with LoopBack 4 |
| [extensions/metrics](https://github.com/loopbackio/loopback-next/tree/master/extensions/metrics) | @loopback/metrics | An extension exposes metrics for Prometheus with LoopBack 4 |
| [extensions/pooling](https://github.com/loopbackio/loopback-next/tree/master/extensions/pooling) | @loopback/pooling | Resource pooling service for LoopBack 4 |
| [extensions/socketio](https://github.com/loopbackio/loopback-next/tree/master/extensions/socketio) | @loopback/socketio | LoopBack's WebSocket server based on socket.io |
| [extensions/typeorm](https://github.com/loopbackio/loopback-next/tree/master/extensions/typeorm) | @loopback/typeorm | Adds support for TypeORM in LoopBack |
| [fixtures/mock-oauth2-provider](https://github.com/loopbackio/loopback-next/tree/master/fixtures/mock-oauth2-provider) | @loopback/mock-oauth2-provider | An internal application to mock the OAuth2 authorization flow login with a social app like facebook, google etc |
| [fixtures/tsdocs-monorepo](https://github.com/loopbackio/loopback-next/tree/master/fixtures/tsdocs-monorepo) | _(private)_ | A monorepo for tsdocs testing |
| [packages/authentication](https://github.com/loopbackio/loopback-next/tree/master/packages/authentication) | @loopback/authentication | A LoopBack component for authentication support. |
| [packages/authorization](https://github.com/loopbackio/loopback-next/tree/master/packages/authorization) | @loopback/authorization | A LoopBack component for authorization support. |
| [packages/boot](https://github.com/loopbackio/loopback-next/tree/master/packages/boot) | @loopback/boot | A collection of Booters for LoopBack 4 Applications |
| [packages/booter-lb3app](https://github.com/loopbackio/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 |
| [packages/build](https://github.com/loopbackio/loopback-next/tree/master/packages/build) | @loopback/build | A set of common scripts and default configurations to build LoopBack 4 or other TypeScript modules |
| [packages/cli](https://github.com/loopbackio/loopback-next/tree/master/packages/cli) | @loopback/cli | Yeoman generator for LoopBack 4 |
| [packages/context](https://github.com/loopbackio/loopback-next/tree/master/packages/context) | @loopback/context | Facilities to manage artifacts and their dependencies in your Node.js applications. The module exposes TypeScript/JavaScript APIs and decorators to register artifacts, declare dependencies, and resolve artifacts by keys. It also serves as an IoC container to support dependency injection |
| [packages/core](https://github.com/loopbackio/loopback-next/tree/master/packages/core) | @loopback/core | Define and implement core constructs such as Application and Component |
| [packages/eslint-config](https://github.com/loopbackio/loopback-next/tree/master/packages/eslint-config) | @loopback/eslint-config | ESLint configuration for LoopBack projects |
| [packages/express](https://github.com/loopbackio/loopback-next/tree/master/packages/express) | @loopback/express | Integrate with Express and expose middleware infrastructure for sequence and interceptors |
| [packages/filter](https://github.com/loopbackio/loopback-next/tree/master/packages/filter) | @loopback/filter | Utility typings and filters for LoopBack filters. |
| [packages/http-caching-proxy](https://github.com/loopbackio/loopback-next/tree/master/packages/http-caching-proxy) | @loopback/http-caching-proxy | A caching HTTP proxy for integration tests. NOT SUITABLE FOR PRODUCTION USE! |
| [packages/http-server](https://github.com/loopbackio/loopback-next/tree/master/packages/http-server) | @loopback/http-server | A wrapper for creating HTTP/HTTPS servers |
| [packages/metadata](https://github.com/loopbackio/loopback-next/tree/master/packages/metadata) | @loopback/metadata | Utilities to help developers implement TypeScript decorators, define/merge metadata, and inspect metadata |
| [packages/model-api-builder](https://github.com/loopbackio/loopback-next/tree/master/packages/model-api-builder) | @loopback/model-api-builder | Types and helpers for packages contributing Model API builders. |
| [packages/monorepo](https://github.com/loopbackio/loopback-next/tree/master/packages/monorepo) | @loopback/monorepo | A set of scripts to maintain a lerna monorepo |
| [packages/openapi-spec-builder](https://github.com/loopbackio/loopback-next/tree/master/packages/openapi-spec-builder) | @loopback/openapi-spec-builder | Make it easy to create OpenAPI (Swagger) specification documents in your tests using the builder pattern. |
| [packages/openapi-v3](https://github.com/loopbackio/loopback-next/tree/master/packages/openapi-v3) | @loopback/openapi-v3 | Decorators that annotate LoopBack artifacts with OpenAPI v3 metadata and utilities that transform LoopBack metadata to OpenAPI v3 specifications |
| [packages/repository](https://github.com/loopbackio/loopback-next/tree/master/packages/repository) | @loopback/repository | Define and implement a common set of interfaces for interacting with databases |
| [packages/repository-json-schema](https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema) | @loopback/repository-json-schema | Converts TS classes into JSON Schemas using TypeScript's reflection API |
| [packages/repository-tests](https://github.com/loopbackio/loopback-next/tree/master/packages/repository-tests) | @loopback/repository-tests | A shared test suite to verify `/repository` functionality with a given compatible connector |
| [packages/rest](https://github.com/loopbackio/loopback-next/tree/master/packages/rest) | @loopback/rest | Expose controllers as REST endpoints and route REST API requests to controller methods |
| [packages/rest-crud](https://github.com/loopbackio/loopback-next/tree/master/packages/rest-crud) | @loopback/rest-crud | REST API controller implementing default CRUD semantics |
| [packages/rest-explorer](https://github.com/loopbackio/loopback-next/tree/master/packages/rest-explorer) | @loopback/rest-explorer | LoopBack's API Explorer |
| [packages/security](https://github.com/loopbackio/loopback-next/tree/master/packages/security) | @loopback/security | A LoopBack component for security support. |
| [packages/service-proxy](https://github.com/loopbackio/loopback-next/tree/master/packages/service-proxy) | @loopback/service-proxy | A common set of interfaces for interacting with service oriented backends such as REST APIs, SOAP Web Services, and gRPC microservices |
| [packages/testlab](https://github.com/loopbackio/loopback-next/tree/master/packages/testlab) | @loopback/testlab | A collection of test utilities we use to write LoopBack tests. |
| [packages/tsdocs](https://github.com/loopbackio/loopback-next/tree/master/packages/tsdocs) | @loopback/tsdocs | An package to generate api docs using Microsoft api-extractor and api-documenter |
| [sandbox/example](https://github.com/loopbackio/loopback-next/tree/master/sandbox/example) | _(private)_ | Sample project for sandbox |
We use npm scripts declared in
[package.json](https://github.com/loopbackio/loopback-next/blob/master/package.json)
to work with the monorepo managed by lerna. See
[Developing LoopBack](./DEVELOPING.md) for more details.