Merge pull request #15 from strongloop/SLS-434_pt3
intro edits and TOC adjustments - includes SLA-469
This commit is contained in:
Ritchie Martori
commit
28ef0becd4
|
|
@ -6,8 +6,10 @@
|
||||||
|
|
||||||
###Model
|
###Model
|
||||||
|
|
||||||
LoopBack is centered around models. A model is an object that encapsulates data. A model is usually named after its
|
LoopBack is centered around models. A model is an object that
|
||||||
real life counterpart. Like its real life counterpart, a model has some properties. Each property has a name, a type,
|
encapsulates data. A model is usually named after its
|
||||||
|
real life counterpart. Like its real life counterpart, a model has
|
||||||
|
some properties. Each property has a name, a type,
|
||||||
and other attributes. For example,
|
and other attributes. For example,
|
||||||
|
|
||||||
model: Person
|
model: Person
|
||||||
|
|
@ -16,7 +18,8 @@ and other attributes. For example,
|
||||||
- a Person model has properties such as First Name, Last Name and Birthday.
|
- a Person model has properties such as First Name, Last Name and Birthday.
|
||||||
- First Name and Last Name are strings while Birthday is date.
|
- First Name and Last Name are strings while Birthday is date.
|
||||||
|
|
||||||
A model can also do things as actions and behaviors. Some actions are common to all instances of the same model while
|
A model can also do things as actions and behaviors. Some actions
|
||||||
|
are common to all instances of the same model while
|
||||||
others are specific to a given instance. For example,
|
others are specific to a given instance. For example,
|
||||||
|
|
||||||
model: Person
|
model: Person
|
||||||
|
|
@ -25,19 +28,26 @@ others are specific to a given instance. For example,
|
||||||
- a Person model can say his/her Full Name (relying on a given instance)
|
- a Person model can say his/her Full Name (relying on a given instance)
|
||||||
- a Person model can find people by Last Name (independent of instances)
|
- a Person model can find people by Last Name (independent of instances)
|
||||||
|
|
||||||
Models are the vehicle for data exchange and data representation across different layers in LoopBack. For example, the
|
Models are the vehicle for data exchange and data representation
|
||||||
Person model is available as database tables, Node.js classes, REST resources, and mobile SDK objects.
|
across different layers in LoopBack. For example, the
|
||||||
|
Person model is available as database tables, Node.js classes, REST
|
||||||
|
resources, and mobile SDK objects.
|
||||||
|
|
||||||
When developing your mobile applications, think of models being the "M" in your MVC framework. Models in LoopBack have
|
When developing your mobile applications, think of models being the
|
||||||
backend connectivity built in already, so that you can save data back to your backend and call actions or functions run
|
"M" in your MVC framework. Models in LoopBack have
|
||||||
|
backend connectivity built in already, so that you can save data
|
||||||
|
back to your backend and call actions or functions run
|
||||||
on the backend seamlessly from your mobile application.
|
on the backend seamlessly from your mobile application.
|
||||||
|
|
||||||
###LoopBack Definition Language (LDL)
|
###LoopBack Definition Language (LDL)
|
||||||
|
|
||||||
All models in LoopBack can be described as JSON objects. LoopBack has utilized and extended JSON to define a model's
|
All models in LoopBack can be described as JSON objects. LoopBack
|
||||||
properties and structure. The JSON that is utilized to help define a model's properties and structure or schema is called
|
has utilized and extended JSON to define a model's properties and
|
||||||
LoopBack Definition Language (LDL). LDL is simple DSL to define data models in JavaScript or plain JSON. The model
|
structure. The JSON that is utilized to help define a model's
|
||||||
definitions establish common knowledge of data in LoopBack. For example,
|
properties and structure or schema is called LoopBack Definition
|
||||||
|
language (LDL). LDL is a simple DSL to define data models in
|
||||||
|
JavaScript or plain JSON. The model definitions establish common
|
||||||
|
knowledge of data in LoopBack. For example,
|
||||||
|
|
||||||
model: Person
|
model: Person
|
||||||
|
|
||||||
|
|
@ -52,18 +62,26 @@ For more information, please read [LoopBack Definition Language Guide](/loopback
|
||||||
|
|
||||||
###Datasources and Connectors
|
###Datasources and Connectors
|
||||||
|
|
||||||
LoopBack allows you to connect to many sources of data and services in the cloud and on premise in your data center.
|
LoopBack allows you to connect to many sources of data and services
|
||||||
These sources of data and services are called DataSources. DataSources are accessed through a plugin called a Connector
|
in the cloud and on premise in your data center.
|
||||||
in LoopBack. Plugins are highly customizable and extensible. Unlike other mobile backend, LoopBack can leverage your
|
These sources of data and services are called DataSources.
|
||||||
existing data and organize them in the form of models.
|
DataSources are accessed through a plugin called a Connector
|
||||||
|
in LoopBack. Plugins are highly customizable and extensible.
|
||||||
|
Unlike other mobile backend, LoopBack can leverage your existing
|
||||||
|
data and organize them in the form of models.
|
||||||
|
|
||||||
The concept of DataSource is introduced to encapsulate business logic to exchange data between models and various data sources.
|
The concept of DataSource is introduced to encapsulate business
|
||||||
Data sources are typically databases that provide create, retrieve, update, and delete (CRUD) functions. LoopBack also generalize
|
logic to exchange data between models and various data sources.
|
||||||
|
Data sources are typically databases that provide create, retrieve,
|
||||||
|
update, and delete (CRUD) functions. LoopBack also generalize
|
||||||
other backend services, such as REST APIs, SOAP Web Services, and Storage Services, as data sources.
|
other backend services, such as REST APIs, SOAP Web Services, and Storage Services, as data sources.
|
||||||
|
|
||||||
Data sources are backed by connectors which implement the data exchange logic using database drivers or other client APIs.
|
Data sources are backed by connectors which implement the data
|
||||||
In general, connectors are not used directly by application code. The DataSource class provides APIs to configure the
|
exchange logic using database drivers or other client APIs.
|
||||||
underlying connector and exposes functions via DataSource or model classes.
|
In general, connectors are not used directly by application code.
|
||||||
|
The DataSource class provides APIs to configure the
|
||||||
|
underlying connector and exposes functions via DataSource or model
|
||||||
|
classes.
|
||||||
|
|
||||||
#### LoopBack Connector Modules
|
#### LoopBack Connector Modules
|
||||||
|
|
||||||
|
|
@ -78,15 +96,28 @@ For more information, please read [LoopBack DataSource and Connector Guide](/loo
|
||||||
|
|
||||||
### REST
|
### REST
|
||||||
|
|
||||||
Everything defined in LoopBack is available to you as a REST endpoint. For every model that is created in LoopBack, a
|
Everything defined in LoopBack is available to you as a REST
|
||||||
REST endpoint is automatically created for you. You can see and experiment with your REST api using the [LoopBack API Explorer](http://localhost:3000/explorer/).
|
endpoint. For every model that is created in LoopBack, a
|
||||||
|
REST endpoint is automatically created for you. You can see and
|
||||||
|
experiment with your REST api using the [LoopBack API Explorer](http://localhost:3000/explorer/).
|
||||||
|
|
||||||
LoopBack also supports other protocols for your API as well. Socket.io is another protocol that is currently being developed.
|
LoopBack also supports other protocols for your API as well. Socket.
|
||||||
|
io is another protocol that is currently being developed.
|
||||||
|
|
||||||
For more information, please read [Model REST APIs](#model-rest-api).
|
For more information, please read [Model REST APIs](#model-rest-api).
|
||||||
|
|
||||||
### Mix In
|
|
||||||
|
|
||||||
### Remoting
|
### Remoting
|
||||||
|
|
||||||
|
With LoopBack you can add whatever functionality you like either
|
||||||
|
by yourself or leveraging functionality from other open source
|
||||||
|
modules from the community. The ability to "mix in" behaviors are
|
||||||
|
available through the inherent power of Javascript's less resrictive
|
||||||
|
inheritance model.
|
||||||
|
|
||||||
|
LoopBack takes this one step further by allowing you to seamlessly
|
||||||
|
invoke server side code running in LoopBack in the backend from the
|
||||||
|
your client on the front end.
|
||||||
|
|
||||||
|
For more information, please read the [Remoting Guide](/strong-remoting.README.md).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,9 @@
|
||||||
##Getting Started
|
###Getting Started
|
||||||
|
|
||||||
|
|
||||||
Placeholder for LoopBack Getting Started Guides
|
Placeholder for LoopBack Getting Started Guides
|
||||||
|
|
||||||
Here we want to insert the boxes - iOS, Android, HTML5/Javascript, REST
|
Here we want to insert the boxes - iOS, Android, HTML5/Javascript,
|
||||||
|
REST
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -1,13 +1,21 @@
|
||||||
##LoopBack
|
#LoopBack
|
||||||
**v1.0.0**
|
**v1.0.0**
|
||||||
|
|
||||||
> **Introduction**
|
LoopBack is part of the [StrongLoop Suite](www.strongloop.com/strongloop-suite)
|
||||||
>
|
|
||||||
> LoopBack is a mobile backend framework that puts you in control. As a mobile developer you decide where to run your mobile backend - in the cloud or on permise.
|
LoopBack is a mobile backend framework that puts you in control. As
|
||||||
> LoopBack is built on open source Node.js and leverages the power of Node and the community that stands behind Node.
|
a mobile developer you decide where to run your mobile backend - in
|
||||||
>
|
the cloud or on permise.
|
||||||
> LoopBack is here to help you develop mobile applications with rich functionality and data that is in your datacenter and the cloud.
|
LoopBack is built on [StrongNode](/strongnode) and open source Node.
|
||||||
> Since LoopBack is built on open source, it is highly extensible and familiar with developers already using Node.
|
js modules. It leverages the power of Node, the community that
|
||||||
> Node.js leverages Javascript. The ubiquituous language of the web that most developers have already had familiarity with it's ease of use.
|
stands behind Node, and the support that [StrongLoop](www.strongloop.com) offers.
|
||||||
|
|
||||||
|
LoopBack is here to help you develop mobile applications with rich
|
||||||
|
functionality and data that is in your datacenter and the cloud.
|
||||||
|
Since LoopBack is built on open source, it is highly extensible and
|
||||||
|
familiar with developers already using Node.
|
||||||
|
Node.js leverages Javascript. The ubiquituous language of the web
|
||||||
|
that most developers have already had familiarity with it's ease of
|
||||||
|
use.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
## Loopback
|
|
||||||
**v0.9.0**
|
|
||||||
|
|
||||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
|
||||||
|
|
||||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident.
|
|
||||||
|
|
||||||
### Quick Start
|
|
||||||
|
|
||||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
|
||||||
|
|
||||||
### Seven Principles
|
|
||||||
|
|
||||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
|
||||||
|
|
||||||
### Resources
|
|
||||||
|
|
||||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
##Quick Start
|
###Quick Start
|
||||||
|
|
||||||
**Step 1** Install the [StrongLoop Suite](#NEED_LINK)
|
**Step 1** Install the [StrongLoop Suite](#NEED_LINK)
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
##Resources
|
###Resources
|
||||||
|
|
||||||
LoopBack was started by StrongLoop. For more information, check out the Node Republic - a community around Node and StrongLoop products.
|
LoopBack was created by StrongLoop. For more information, check out
|
||||||
|
the Node Republic - a community around Node and StrongLoop products.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue