loopback/README.md

93 lines
4.5 KiB
Markdown
Raw Normal View History

2015-01-13 18:19:58 +00:00
# LoopBack
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/strongloop/loopback?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2014-07-25 18:48:52 +00:00
LoopBack is a highly-extensible, open-source Node.js framework that enables you to:
2014-05-14 18:55:04 +00:00
2014-07-25 18:48:52 +00:00
* Create dynamic end-to-end REST APIs with little or no coding.
* Access data from Oracle, MySQL, PostgreSQL, MS SQL Server, MongoDB, SOAP and other REST APIs.
* Incorporate model relationships and access controls for complex APIs.
* Use built-in push, geolocation, and file services for mobile apps.
* Easily create client apps using Android, iOS, and JavaScript SDKs.
* Run your application on-premises or in the cloud.
2014-05-14 18:55:04 +00:00
LoopBack consists of:
2014-07-25 18:48:52 +00:00
2014-05-14 18:55:04 +00:00
* A library of Node.js modules.
2014-07-25 18:48:52 +00:00
* [Yeoman](http://yeoman.io/) generators for scaffolding applications.
* Client SDKs for iOS, Android, and web clients.
2015-01-13 18:19:58 +00:00
LoopBack tools include:
* Command-line tool `slc loopback` to create applications, models, data sources, and so on.
* StrongLoop Arc, a graphical tool for editing LoopBack applications; and for deploying and monitoring applications.
2014-05-14 18:55:04 +00:00
For more details, see [http://loopback.io/](http://loopback.io/).
2014-05-14 18:55:04 +00:00
2014-07-12 06:31:13 +00:00
## LoopBack modules
2014-05-14 18:55:04 +00:00
2014-07-30 17:15:03 +00:00
The LoopBack framework is a set of Node.js modules that you can use independently or together.
2014-05-19 21:16:31 +00:00
2014-05-22 18:58:27 +00:00
![LoopBack modules](https://github.com/strongloop/loopback/raw/master/docs/assets/lb-modules.png "LoopBack modules")
2014-05-14 18:55:04 +00:00
2014-07-25 18:48:52 +00:00
### Core
* [loopback](https://github.com/strongloop/loopback)
* [loopback-datasource-juggler](https://github.com/strongloop/loopback-datasource-juggler)
* [strong-remoting](https://github.com/strongloop/strong-remoting)
### Connectors
* [loopback-connector-mongodb](https://github.com/strongloop/loopback-connector-mongodb)
* [loopback-connector-mysql](https://github.com/strongloop/loopback-connector-mysql)
* [loopback-connector-postgresql](https://github.com/strongloop/loopback-connector-postgresql)
* [loopback-connector-rest](https://github.com/strongloop/loopback-connector-rest)
### Enterprise Connectors
* [loopback-connector-oracle](https://github.com/strongloop/loopback-connector-oracle)
* [loopback-connector-mssql](https://github.com/strongloop/loopback-connector-mssql)
* [loopback-connector-soap](https://github.com/strongloop/loopback-connector-soap)
2015-01-13 18:19:58 +00:00
* [loopback-connector-atg](https://github.com/strongloop/loopback-connector-atg)
2014-07-25 18:48:52 +00:00
### Community Connectors
The LoopBack community has created and supports a number of additional connectors. See [Community connectors](http://loopback.io/doc/en/lb2/Community-connectors.html) for details.
2014-07-25 18:48:52 +00:00
### Components
* [loopback-component-push](https://github.com/strongloop/loopback-component-push)
* [loopback-component-storage](https://github.com/strongloop/loopback-component-storage)
* [loopback-component-passport](https://github.com/strongloop/loopback-component-passport)
### Client SDKs
* [loopback-sdk-ios](https://github.com/strongloop/loopback-sdk-ios)
* [loopback-sdk-android](https://github.com/strongloop/loopback-sdk-android)
* [loopback-sdk-angular](https://github.com/strongloop/loopback-sdk-angular)
2014-07-03 20:52:03 +00:00
* [loopback-sdk-angular-cli](https://github.com/strongloop/loopback-sdk-angular-cli)
* [grunt-loopback-sdk-angular](https://github.com/strongloop/grunt-loopback-sdk-angular)
2014-05-14 18:55:04 +00:00
2014-07-25 18:48:52 +00:00
### Tools
* [loopback-explorer](https://github.com/strongloop/loopback-explorer)
* [loopback-workspace](https://github.com/strongloop/loopback-workspace)
* [generator-loopback](https://github.com/strongloop/generator-loopback)
### Examples
2015-03-03 19:14:26 +00:00
StrongLoop provides a number of example applications that illustrate various key LoopBack features. In some cases, they have accompanying step-by-step instructions (tutorials).
See [loopback-example](https://github.com/strongloop/loopback-example) for details.
2014-04-02 17:34:29 +00:00
2014-07-12 06:31:13 +00:00
## Resources
2013-04-09 16:02:36 +00:00
* [Documentation](http://loopback.io/doc/).
2014-05-14 19:10:41 +00:00
* [API documentation](http://apidocs.strongloop.com/loopback).
* [LoopBack Google Group](https://groups.google.com/forum/#!forum/loopbackjs).
* [GitHub issues](https://github.com/strongloop/loopback/issues).
2015-01-13 18:19:53 +00:00
* [Gitter chat](https://gitter.im/strongloop/loopback).
2013-10-25 18:17:21 +00:00
## Contributing
2016-10-13 22:57:19 +00:00
Contributions to the LoopBack project are welcome! See [Contributing to LoopBack](http://loopback.io/doc/en/contrib/index.html) for more information.
2014-04-28 17:57:26 +00:00
2016-10-13 22:57:19 +00:00
## Reporting issues
2015-02-03 19:59:45 +00:00
2016-10-13 22:57:19 +00:00
One of the easiest ways to contribute to LoopBack is to report an issue. See [Reporting issues](http://loopback.io/doc/en/contrib/Reporting-issues.html) for more information.
2014-05-19 20:19:12 +00:00
[![Analytics](https://sl-beacon.appspot.com/UA-37775386-1/github/loopback/readme?pixel)](https://github.com/strongloop/loopback)