strongloopLoopBack Boot
This module is in Active LTS mode, new features are no longer accepted.
(See Module Long Term Support Policy
below.)
LoopBack 3 users looking for new features are encouraged to upgrade to LoopBack 4. Refer to loopback-next#1849 for more information on how to upgrade.
Overview
A convention-based bootstrapper for LoopBack applications.
For full documentation, see the official StrongLoop documentation: Defining boot scripts and Creating a LoopBack application.
The loopback-boot module initializes (bootstraps) a LoopBack application. Specifically, it:
- Configures data-sources.
- Defines custom models
- Configures models and attaches models to data-sources.
- Configures application settings
- Runs additional boot scripts, so you can put custom setup code in multiple small files instead of in the main application file.
For more information, see Defining boot scripts.
Version notes
The version range 1.x is backwards compatible with app.boot provided
by LoopBack 1.x versions and the project layout scaffolded by slc lb project
up to slc version 2.5.
The version range 2.x supports the new project layout as scaffolded by
yo loopback.
This document describes the configuration conventions of the 2.x versions.
Installation
npm install loopback-boot
Usage
var loopback = require('loopback');
var boot = require('loopback-boot');
var app = loopback();
boot(app, __dirname);
app.use(loopback.rest());
app.listen();
See API docs for complete API reference.
Module Long Term Support Policy
This module adopts the Module Long Term Support (LTS) policy, with the following End Of Life (EOL) dates:
| Version | Status | Published | EOL |
|---|---|---|---|
| 3.x | Active LTS | May 2017 | Dec 2020 |
| 2.x | End-of-Life | Jul 2014 | Apr 2019 |
Learn more about our LTS plan in docs.
License
This module is provided under dual MIT/StrongLoop license. See LICENSE for details.