3129f6495c
The name `models.json` was potentially confusing since there are no models defined in that file. |
||
|---|---|---|
| docs | ||
| lib | ||
| test | ||
| .gitignore | ||
| .jshintignore | ||
| .jshintrc | ||
| CHANGES.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
| browser.js | ||
| docs.json | ||
| index.js | ||
| package.json | ||
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.