Convention-based bootstrapper for LoopBack applications

Go to file

Raymond Feng ed59cb2483 Fix jsdoc		2014-10-30 13:34:59 -07:00
docs	support coffee-script models and client code	2014-10-24 10:42:30 -07:00
lib	Fix jsdoc	2014-10-30 13:34:59 -07:00
test	support coffee-script models and client code	2014-10-24 10:42:30 -07:00
.gitignore	gitignore: add Idea's *.iml files	2014-10-08 17:15:30 +02:00
.jshintignore	Custom rootDir for models and datasources	2014-05-27 14:49:11 +02:00
.jshintrc	Add support for async boot scripts	2014-10-09 12:18:36 -07:00
CHANGES.md	Start CHANGES.md	2014-05-27 16:18:09 +02:00
CONTRIBUTING.md	Update contribution guidelines	2014-10-01 18:06:20 -07:00
LICENSE	Initial commit	2014-05-23 15:51:20 +02:00
README.md	Remove non-API docs.	2014-07-09 07:36:45 +02: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	Fix jsdoc	2014-10-30 13:34:59 -07:00
package.json	2.3.0	2014-10-27 11:14:19 +01:00

README.md

LoopBack Boot

A convention-based bootstrapper for LoopBack applications.

For full documentation, see the official StrongLoop documentation: Application initialization 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 Application initialization.

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. See the official documentation for instructions on upgrading existing projects.

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.