loopback/README.md

LoopBack

⚠️ LoopBack 3 has reached end of life. We are no longer accepting pull requests or providing support for community users. The only exception is fixes for critical bugs and security vulnerabilities provided as part of support for IBM API Connect customers. We urge all LoopBack 3 users to migrate their applications to LoopBack 4 as soon as possible. Learn more about LoopBack's long term support policy. will be provided or accepted. (See Module Long Term Support Policy below.)

We urge all LoopBack 3 users to migrate their applications to LoopBack 4 as soon as possible. Refer to our Migration Guide for more information on how to upgrade.

Overview

LoopBack is a highly-extensible, open-source Node.js framework that enables you to:

• Create dynamic end-to-end REST APIs with little or no coding.
• Access data from Oracle, MySQL, PostgreSQL, MS SQL Server, MongoDB, SOAP and other REST APIs.
• Incorporate model relationships and access controls for complex APIs.
• Use built-in push, geolocation, and file services for mobile apps.
• Easily create client apps using Android, iOS, and JavaScript SDKs.
• Run your application on-premises or in the cloud.

LoopBack consists of:

• A library of Node.js modules.
• Yeoman generators for scaffolding applications.
• Client SDKs for iOS, Android, and web clients.

LoopBack tools include:

• Command-line tool loopback-cli to create applications, models, data sources, and so on.

For more details, see https://loopback.io/.

Module Long Term Support Policy

LoopBack 3.x has reached End-of-Life.

This module adopts the Module Long Term Support (LTS) policy, with the following End Of Life (EOL) dates:

Version	Status	Published	EOL
LoopBack 4	Current	Oct 2018	Apr 2023 (minimum)
LoopBack 3	End-of-Life	Dec 2016	Dec 2020
LoopBack 2	End-of-Life	Jul 2014	Apr 2019

Learn more about our LTS plan in docs.

LoopBack modules

The LoopBack framework is a set of Node.js modules that you can use independently or together.

Core

• loopback
• loopback-datasource-juggler
• strong-remoting

Connectors

• loopback-connector-mongodb
• loopback-connector-mysql
• loopback-connector-postgresql
• loopback-connector-rest

Enterprise Connectors

• loopback-connector-oracle
• loopback-connector-mssql
• loopback-connector-soap
• loopback-connector-atg

Community Connectors

The LoopBack community has created and supports a number of additional connectors. See Community connectors for details.

Components

• loopback-component-push
• loopback-component-storage
• loopback-component-passport

Client SDKs

• loopback-sdk-ios
• loopback-sdk-android
• loopback-sdk-angular
  • loopback-sdk-angular-cli
  • grunt-loopback-sdk-angular

Tools

• loopback-explorer
• loopback-workspace
• generator-loopback

Examples

StrongLoop provides a number of example applications that illustrate various key LoopBack features. In some cases, they have accompanying step-by-step instructions (tutorials).

See examples at loopback.io for details.

Resources

• Documentation.
• API documentation.
• LoopBack Announcements
• LoopBack Google Group.
• GitHub issues.
• Gitter chat.

Contributing

Contributions to the LoopBack project are welcome! See Contributing to LoopBack for more information.

Reporting issues

One of the easiest ways to contribute to LoopBack is to report an issue. See Reporting issues for more information.