Page Contents

Monorepo overview

The loopback-next repository uses lerna 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 (private) Acceptance test for @loopback/extension-logging with fluentd
acceptance/repository-cloudant (private) Acceptance tests for @loopback/repository + loopback-connector-cloudant
acceptance/repository-mongodb (private) Acceptance tests for @loopback/repository + loopback-connector-mongodb
acceptance/repository-mysql (private) Acceptance tests for @loopback/repository + loopback-connector-mysql
acceptance/repository-postgresql (private) Acceptance tests for @loopback/repository + loopback-connector-postgresql
benchmark (private) Benchmarks measuring performance of our framework.
docs @loopback/docs Documentation files rendered at https://loopback.io
examples/access-control-migration @loopback/example-access-control-migration Tutorial example on how to migrate the access control example with LoopBack 4.
examples/context @loopback/example-context Standalone examples to illustrate features provided by @loopback/context
examples/express-composition @loopback/example-express-composition LoopBack 4 REST API on Express
examples/file-transfer @loopback/example-file-transfer Example application for file upload/download with LoopBack 4
examples/greeter-extension @loopback/example-greeter-extension An example showing how to implement the extension point/extension pattern using LoopBack 4
examples/greeting-app @loopback/example-greeting-app An example greeting application for LoopBack 4
examples/hello-world @loopback/example-hello-world A simple hello-world Application using LoopBack 4
examples/lb3-application @loopback/example-lb3-application Tutorial example on how to add existing an LB3 application to a LB4 project
examples/log-extension @loopback/example-log-extension An example showing how to write a complex log extension for LoopBack 4
examples/metrics-prometheus @loopback/example-metrics-prometheus An example to illustrate metrics provided by @loopback/extension-metrics and Prometheus
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 @loopback/example-passport-login An example to demonstrate authentication with passport strategies
examples/rest-crud @loopback/example-rest-crud An example showing how to use @loopback/rest-crud to define default repository and controller classes
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 @loopback/example-soap-calculator A tutorial demonstrating integration SOAP webservice with LoopBack 4
examples/todo @loopback/example-todo Tutorial example on how to build an application with LoopBack 4
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 @loopback/example-todo-list Continuation of the todo example using relations in LoopBack 4.
examples/validation-app @loopback/example-validation-app An example demonstrating how to add validation in a LoopBack 4 application
extensions/apiconnect @loopback/apiconnect An extension for IBM API Connect
extensions/authentication-jwt @loopback/authentication-jwt Extension for the prototype of JWT authentication
extensions/authentication-passport @loopback/authentication-passport A package creating adapters between the passport module and @loopback/authentication
extensions/context-explorer @loopback/context-explorer Visualize context hierarchy, bindings, configurations, and dependencies
extensions/cron @loopback/cron Schedule tasks using cron-like syntax
extensions/health @loopback/extension-health An extension exposes health check related endpoints with LoopBack 4
extensions/logging @loopback/extension-logging An extension exposes logging for Winston and Fluentd with LoopBack 4
extensions/metrics @loopback/extension-metrics An extension exposes metrics for Prometheus with LoopBack 4
fixtures/mock-oauth2-provider (private) An internal application to mock the OAuth2 authorization flow login with a social app like facebook, google etc
fixtures/tsdocs-monorepo (private) A monorepo for tsdocs testing
packages/authentication @loopback/authentication A LoopBack component for authentication support.
packages/authorization @loopback/authorization A LoopBack component for authorization support.
packages/boot @loopback/boot A collection of Booters for LoopBack 4 Applications
packages/booter-lb3app @loopback/booter-lb3app A booter component for LoopBack 3 applications to expose their REST API via LoopBack 4
packages/build @loopback/build A set of common scripts and default configurations to build LoopBack 4 or other TypeScript modules
packages/cli @loopback/cli Yeoman generator for LoopBack 4
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 @loopback/core Define and implement core constructs such as Application and Component
packages/eslint-config @loopback/eslint-config ESLint configuration for LoopBack projects
packages/express @loopback/express Integrate with Express and expose middleware infrastructure for sequence and interceptors
packages/http-caching-proxy @loopback/http-caching-proxy A caching HTTP proxy for integration tests. NOT SUITABLE FOR PRODUCTION USE!
packages/http-server @loopback/http-server A wrapper for creating HTTP/HTTPS servers
packages/metadata @loopback/metadata Utilities to help developers implement TypeScript decorators, define/merge metadata, and inspect metadata
packages/model-api-builder @loopback/model-api-builder Types and helpers for packages contributing Model API builders.
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 @loopback/openapi-v3 Decorators that annotate LoopBack artifacts with OpenAPI v3 metadata and utilities that transform LoopBack metadata to OpenAPI v3 specifications
packages/repository @loopback/repository Define and implement a common set of interfaces for interacting with databases
packages/repository-json-schema @loopback/repository-json-schema Converts TS classes into JSON Schemas using TypeScript’s reflection API
packages/repository-tests @loopback/repository-tests A shared test suite to verify @loopback/repository functionality with a given compatible connector
packages/rest @loopback/rest Expose controllers as REST endpoints and route REST API requests to controller methods
packages/rest-crud @loopback/rest-crud REST API controller implementing default CRUD semantics
packages/rest-explorer @loopback/rest-explorer LoopBack’s API Explorer
packages/security @loopback/security A LoopBack component for security support.
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 @loopback/testlab A collection of test utilities we use to write LoopBack tests.
packages/tsdocs (private) An internal package to generate api docs using Microsoft api-extractor and api-documenter
sandbox/example (private) Sample project for sandbox

We use npm scripts declared in package.json to work with the monorepo managed by lerna. See Developing LoopBack for more details.