README.md

loopback-next

LoopBack makes it easy to build modern applications that require complex integrations.

• Fast, small, powerful, extensible core
• Generate real APIs with a single command
• Define your data and endpoints with OpenAPI
• No maintenance of generated code

Status: Developer Preview #1

LoopBack 4 is a work in progress, the public API is frequently changed in backwards-incompatible ways. See Upcoming-Releases on wiki for more details.

Installation

Make sure you have the following installed:

• Node.js >= 8.0.0
• TypeScript >= 2.5.0 npm i -g typescript

Then in your Node.js project root, run:

npm install -S @loopback/core

Make sure you set "target": "es2017" in your compiler options in your tsconfig.json if you're using a TypeScript project. See Installation for detailed information.

Example

A basic controller:

export class UserController {
  async getUserByName(username: string): Promise<UserResponse> {
    const users = new UserRepository();
    const user = await users.findOne({where: {username: username}});
    if (!user) {
      throw createHttpError.NotFound(`User ${username} not found.`);
    }
    return new UserResponse(user);
  }
}

To create your first LoopBack 4 application, See Getting Started.

Documentation

• Official documentation
• API documentation
• FAQ
• LoopBack 3 vs LoopBack 4
• Tutorials and examples

Contributing

See the following resources to get your started:

• Contributing Guidelines
• Monorepo overview
• Developing LoopBack

You can join the team by posting a comment to issue #110.

Team

Project Architects:

Raymond Feng	Miroslav Bajtos	Ritchie Martori	Kevin Delisle

Project Maintainers:

Biniam Admikew	Diana Lau	Janny Hou	Simon Ho
Kyu Shim	Loay Gewily	Rand McKinney	Taranveer Virk

See all contributors.

License

MIT