diff --git a/.gitignore b/.gitignore index e2f7cef8..a84a7659 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ .idea .project .DS_Store +*.sublime* *.seed *.log *.csv diff --git a/docs.json b/docs.json index dc10be11..3cf60488 100644 --- a/docs.json +++ b/docs.json @@ -1,7 +1,11 @@ { + "title": "LoopBack", "content": [ - "docs/loopback.md", + "docs/intro.md", + "docs/quickstart.md", + "docs/gettingstarted.md", + "docs/resources.md", "docs/concepts.md", "docs/api.md" ] -} \ No newline at end of file +} diff --git a/docs/concepts.md b/docs/concepts.md index 6e90cbc4..e07c0b48 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -1,31 +1,50 @@ -## Concepts +##Concepts -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. +###What is a Model? -### Structuring your app +LoopBack is centered around models. A model is an object that encapsulates data. A model is usually named after its real life counterpart. Like its real life counterpart a model has properties or attributes. -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. -### Data and security + Example) -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. + model = person + a person model has properties such as a First Name and Last Name -### Reactivity +A model can also do things as actions and behavior. -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. + Example) -### Live HTML + model = person + a person model can speak and say his/her Full Name -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. +When developing your mobile applications, think of models being the "M" in your MVC framework. Models in LoopBack have backend connectivty 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. -### Templates +###What is LoopBack Definition Language (LDL)? +All models in LoopBack can be represented as JSON objects. LoopBack has utilized and extended JSON to define a model's properties and structure. The JSON that is utilized to help define a model's properties and stucture or schema is called LoopBack Definition Language (LDL). LDL is a type of domain specific language -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. + Example) -### Smart packages + model = person + {firstname : string, lastname : string, age: number} -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. +###What is a Datasource and Connector? -### Deploying +LoopBack allows you to connect to many sources of data and services in the cloud and on premise in your datacenter. These sources of data and services are called Datasources. -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. \ No newline at end of file +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. + +#### Discovery +#### Supported Connectors +#### Connector Spec + +### REST + +Everything defined in LoopBack is availabe to you as a REST 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. + +LoopBack also supports other protocols for your API as well. Socket.io is another protocol that is currently being developed. + +### Mix In + +### Remoting + +--- diff --git a/docs/gettingstarted.md b/docs/gettingstarted.md new file mode 100644 index 00000000..1d669d7a --- /dev/null +++ b/docs/gettingstarted.md @@ -0,0 +1,6 @@ +##Getting Started + + +Placeholder for LoopBack Getting Started Guides + +--- diff --git a/docs/intro.md b/docs/intro.md new file mode 100644 index 00000000..1bb29025 --- /dev/null +++ b/docs/intro.md @@ -0,0 +1,15 @@ +##LoopBack +v1.0.0 + +###What is LoopBack? + +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 built on open source Node.js and leverages the power of Node and the community that stands behind Node. + +###Why use LoopBack? + +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. + +--- diff --git a/docs/quickstart.md b/docs/quickstart.md new file mode 100644 index 00000000..881ce537 --- /dev/null +++ b/docs/quickstart.md @@ -0,0 +1,4 @@ +##Quick Start + + +Placeholder for LoopBack quick start - 0-60 5 min experience diff --git a/docs/resources.md b/docs/resources.md new file mode 100644 index 00000000..ba411e2b --- /dev/null +++ b/docs/resources.md @@ -0,0 +1,5 @@ +##Resources + +LoopBack was started by StrongLoop. For more information, check out the Node Republic - a community around Node and StrongLoop products. + +---