Convention-based bootstrapper for LoopBack applications
Go to file
Miroslav Bajtoš d041d80933 Merge pull request #97 from strongloop/feature/unit-test-booting-flag
Add unit test to check `app.booting` flag
2015-02-23 18:01:52 +01:00
docs support coffee-script models and client code 2014-10-24 10:42:30 -07:00
lib Save instructions.json in root dir 2015-02-19 13:38:13 -08:00
test Add unit test to verify `app.booting flag status 2015-02-20 13:51:53 -08:00
.gitignore Save instructions.json in root dir 2015-02-19 13:38:13 -08: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
CHANGES.md 2.6.5 2015-02-20 12:40:00 +01: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 Remove non-API docs. 2014-07-09 07:36:45 +02:00
docs.json Remove non-API docs. 2014-07-09 07:36:45 +02:00
index.js Configure components via `component-config.json` 2015-01-06 14:00:26 +01:00
package.json 2.6.5 2015-02-20 12:40:00 +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.