Convention-based bootstrapper for LoopBack applications
Go to file
Miroslav Bajtoš b0e5a0bc63 executor: move "booted" and cb() to the next tick
Fix executor to always emit the "booted" event and call the callback
in the next tick of the event loop, regardless of whether there are any
async boot scripts.

Before this change, adding a listener for "booted" event was cumbersome:

    boot(app);
    if (app.booting)
      app.on('booted', handler);
    else
      handler();

With the fix in place, one can simply write the following:

    boot(app);
    app.on('booted', handler);
2016-02-22 11:01:06 +01:00
docs support coffee-script models and client code 2014-10-24 10:42:30 -07:00
lib executor: move "booted" and cb() to the next tick 2016-02-22 11:01:06 +01:00
test executor: move "booted" and cb() to the next tick 2016-02-22 11:01:06 +01:00
.gitignore Support for multiple apps in browserified bundle. 2015-03-19 09:57:32 -07:00
.jscsrc Fix coding style issues, add API docs 2015-05-05 11:28:58 +02:00
.jshintignore Custom rootDir for models and datasources 2014-05-27 14:49:11 +02:00
.jshintrc Add jscs style check, fix violations found 2014-11-13 15:54:59 +01:00
.travis.yml Upgrade Travis to container-based infrastructure 2015-08-24 15:35:56 +02:00
CHANGES.md 2.16.0 2015-12-22 10:03:54 +01:00
CONTRIBUTING.md Fix bad CLA URL in CONTRIBUTING.md 2014-12-29 08:27:45 -08:00
LICENSE.md Refer to licenses with a link 2015-11-03 12:27:49 -08:00
README.md Fix broken links 2015-01-29 12:17:24 -08:00
browser.js Support for multiple apps in browserified bundle. 2015-03-19 09:57:32 -07:00
docs.json Remove non-API docs. 2014-07-09 07:36:45 +02:00
index.js Add jsdoc for `options.mixinSources` 2015-06-30 18:07:22 +02:00
package.json 2.16.0 2015-12-22 10:03:54 +01: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.