52 lines
1.6 KiB
Markdown
52 lines
1.6 KiB
Markdown
# LoopBack Boot
|
|
|
|
A convention-based bootstrapper for LoopBack applications.
|
|
|
|
For full documentation, see the official StrongLoop documentation: [Defining boot scripts](http://docs.strongloop.com/display/LB/Defining+boot+scripts) and [Creating a LoopBack application](http://docs.strongloop.com/display/LB/Creating+an+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](http://docs.strongloop.com/display/LB/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
|
|
|
|
```js
|
|
var loopback = require('loopback');
|
|
var boot = require('loopback-boot');
|
|
|
|
var app = loopback();
|
|
boot(app, __dirname);
|
|
|
|
app.use(loopback.rest());
|
|
app.listen();
|
|
```
|
|
|
|
See [API docs](http://apidocs.strongloop.com/loopback-boot/) for
|
|
complete API reference.
|
|
|
|
## License
|
|
|
|
This module is provided under dual MIT/StrongLoop license. See [LICENSE](LICENSE) for details.
|