loopback/docs/quickstart.md

60 lines
1.5 KiB
Markdown
Raw Normal View History

2013-08-29 01:22:03 +00:00
###Quick Start
2013-09-05 20:25:09 +00:00
<h4>Step 1</h4>
2013-09-16 19:23:08 +00:00
> Install [StrongLoop Suite](http://www.strongloop.com/get-started)
2013-09-05 20:25:09 +00:00
<h4>Step 2</h4>
> Setup the **StrongLoop Suite Sample App**.
2013-08-23 02:00:07 +00:00
```sh
2013-09-05 20:25:09 +00:00
$ slc example
2013-08-23 02:00:07 +00:00
```
2013-09-05 20:25:09 +00:00
The command above takes care of cloning the sample app into a new directory
named `sls-sample-app` and installing all of its dependencies.
<h4>Step 3</h4>
> Run the sample application.
2013-08-23 02:00:07 +00:00
```sh
2013-09-05 20:25:09 +00:00
$ cd sls-sample-app
2013-08-23 02:00:07 +00:00
$ slc run app
```
2013-09-05 20:25:09 +00:00
<h4>Step 4</h4>
> Open the app in a browser.
2013-09-17 21:32:39 +00:00
The sample app should now be running at <a href="http://localhost:3000" target="_blank">http://localhost:3000</a>. The homepage of
2013-09-05 20:25:09 +00:00
the sample app lists several sample requests you can make against the LoopBack
REST API.
<a href="http://localhost:3000" class="status btn btn-primary" target="_blank">
View the Sample App</a>
<h4>Step 5</h4>
> Explore the REST API
To browse all the sample app's REST APIs,
[open the API explorer](http://localhost:3000/explorer)
<a href="http://localhost:3000/explorer" class="status btn btn-primary">View the
API Explorer</a>
<h4>Next Steps</h4>
2013-08-23 02:00:07 +00:00
2013-09-05 20:25:09 +00:00
> Check out the rest of the StrongLoop Suite.
2013-08-23 02:00:07 +00:00
2013-09-05 23:32:10 +00:00
- To see how to consume the API from mobile clients, check out the [Getting Started](#getting-started) guide.
2013-09-05 20:25:09 +00:00
- To see the out-of-the-box scaling capability of the Suite, check out the
[StrongNode Quick Start Guide](http://docs.strongloop.com/strongnode#quick-start).
- To see the provided CPU profiling and path trace features, check out the
[StrongOps Quick Start Guide](http://docs.strongloop.com/strongops#quick-start).
2013-08-23 02:00:07 +00:00
2013-08-27 15:18:32 +00:00
---