Convention-based bootstrapper for LoopBack applications
Go to file
David Cheung f7c9cbc2c6 Merge pull request #181 from strongloop/feature/extensibility
[SEMVER-MAJOR] Refactor for modular and pluggable design
2016-11-22 14:19:29 -05:00
docs Update header-browser.md 2016-10-05 17:25:52 -04:00
intl Refactor for modular and pluggable design 2016-11-22 13:38:28 -05:00
lib Refactor for modular and pluggable design 2016-11-22 13:38:28 -05:00
test Refactor for modular and pluggable design 2016-11-22 13:38:28 -05:00
.eslintignore Use eslint with loopback config 2016-04-05 15:42:58 +02:00
.eslintrc Use eslint with loopback config 2016-04-05 15:42:58 +02:00
.gitignore globalization: add translated strings 2016-09-21 11:38:52 -04:00
.travis.yml Add Node v7 to Travis CI platforms 2016-11-15 15:07:33 +01:00
3.0-RELEASE-NOTES.md Refactor for modular and pluggable design 2016-11-22 13:38:28 -05:00
CHANGES.md 2.22.0 2016-09-05 14:55:34 +02:00
CONTRIBUTING.md Update URLs in CONTRIBUTING.md (#198) 2016-07-13 17:42:46 -07:00
LICENSE update copyright notices and license 2016-05-05 21:52:36 -07:00
README.md readme: update URL to new doc site 2016-10-28 16:28:11 -04:00
browser.js Refactor for modular and pluggable design 2016-11-22 13:38:28 -05:00
docs.json Remove non-API docs. 2014-07-09 07:36:45 +02:00
index.js Refactor for modular and pluggable design 2016-11-22 13:38:28 -05:00
package.json Refactor for modular and pluggable design 2016-11-22 13:38:28 -05:00

README.md

LoopBack Boot

A convention-based bootstrapper for LoopBack applications.

For full documentation, see the official StrongLoop documentation: Defining boot scripts and Creating a LoopBack application.

Overview

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.

License

This module is provided under dual MIT/StrongLoop license. See LICENSE for details.