# loopback-boot

> Convention-based bootstrapper for LoopBack applications

Latest version **3.3.1** (published 2019-06-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install loopback-boot
pnpm add loopback-boot
yarn add loopback-boot
bun add loopback-boot
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.3.1 |
| Published | 2019-06-24 |
| First published | 2014-06-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/loopback-boot) |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 8 |
| Unpacked size | 132.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 62 |
| Author | IBM Corp. |
| Maintainers | b-admike, bajtos, dhmlau, hacksparrow, jannyhou2016, rfeng, rmg |
| Keywords | StrongLoop, LoopBack, Configuration, Bootstrap |

## Links

- npm: https://www.npmjs.com/package/loopback-boot
- Repository: https://github.com/strongloop/loopback-boot
- Homepage: https://github.com/strongloop/loopback-boot#readme
- Issues: https://github.com/strongloop/loopback-boot/issues
- npm.io page: https://npm.io/package/loopback-boot

## Dependencies (8)

- [async](https://npm.io/package/async.md) ^2.4.0
- [debug](https://npm.io/package/debug.md) ^4.1.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [semver](https://npm.io/package/semver.md) ^5.1.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.3
- [toposort](https://npm.io/package/toposort.md) ^2.0.2
- [commondir](https://npm.io/package/commondir.md) ^1.0.1
- [strong-globalize](https://npm.io/package/strong-globalize.md) ^4.1.1

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 3.3.1 (latest) — 2019-06-24
- 2.28.0 (lts) — 2019-03-26
- 3.3.0 — 2019-03-28
- 3.2.1 — 2019-03-22
- 3.2.0 — 2018-10-18
- 3.1.1 — 2018-07-26
- 2.27.1 — 2018-02-26
- 2.27.0 — 2017-10-23
- 3.1.0 — 2017-10-13
- 2.26.2 — 2017-09-15
- 2.26.1 — 2017-08-17
- 2.26.0 — 2017-07-31
- 2.25.0 — 2017-06-26
- 3.0.1 — 2017-06-22
- 2.24.1 — 2017-06-07
- … 49 more at https://npm.io/package/loopback-boot/versions

## README

# LoopBack Boot

**This module is in Active LTS mode, new features are no longer accepted.**
<br/>(See [Module Long Term Support Policy](#module-long-term-support-policy)
below.)

LoopBack 3 users looking for new features are encouraged to upgrade
to LoopBack 4. Refer to
[loopback-next#1849](https://github.com/strongloop/loopback-next/issues/1849)
for more information on how to upgrade.

## Overview

A convention-based bootstrapper for LoopBack applications.

For full documentation, see the official StrongLoop documentation: [Defining boot scripts](https://loopback.io/doc/en/lb2/Defining-boot-scripts) and [Creating a LoopBack application](https://loopback.io/doc/en/lb2/Creating-an-application).

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](https://loopback.io/doc/en/lb2/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.

## Module Long Term Support Policy

This module adopts the [
Module Long Term Support (LTS)](http://github.com/CloudNativeJS/ModuleLTS) policy,
with the following End Of Life (EOL) dates:

| Version | Status          | Published | EOL      |
| ------- | --------------- | --------- | -------- |
| 3.x     | Active LTS      | May 2017  | Dec 2020 |
| 2.x     | End-of-Life     | Jul 2014  | Apr 2019 |

Learn more about our LTS plan in [docs](https://loopback.io/doc/en/contrib/Long-term-support.html).

## License

This module is provided under dual MIT/StrongLoop license.  See [LICENSE](LICENSE) for details.

---
_Source: https://npm.io/package/loopback-boot · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._