Convention-based bootstrapper for LoopBack applications
Go to file
Shlomi Assaf b6c60a297d Extend options arg to support custom model definitions
Extend the options argument of boot/compile to allow the developer
to supply custom model definitions (to replace the result of
findModelDefinitions). Together with the existing options.models,
it allows to specify all model-related data and still use the benefits
which loopback-boot provides (most notably loading models in order
defined by inheritance, i.e. base models are loaded before models that
are extending them).
2015-05-05 11:24:02 +02:00
docs support coffee-script models and client code 2014-10-24 10:42:30 -07:00
lib Extend options arg to support custom model definitions 2015-05-05 11:24:02 +02:00
test Extend options arg to support custom model definitions 2015-05-05 11:24:02 +02:00
.gitignore Support for multiple apps in browserified bundle. 2015-03-19 09:57:32 -07:00
.jscsrc Add jscs style check, fix violations found 2014-11-13 15:54:59 +01: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 Configure Travis CI builds 2015-04-17 09:12:45 +02:00
CHANGES.md 2.7.1 2015-04-23 09:32:10 +02:00
CONTRIBUTING.md Fix bad CLA URL in CONTRIBUTING.md 2014-12-29 08:27:45 -08:00
LICENSE Initial commit 2014-05-23 15:51:20 +02: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 support for mixins 2015-04-24 12:42:56 +05:30
package.json add support for mixins 2015-04-24 12:42:56 +05:30

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.