-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(example-getting-started): tutorial cleanup #1056
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,23 +2,76 @@ | |
|
||
This is the basic tutorial for getting started with Loopback 4! | ||
|
||
To get started, jump into the | ||
[Prerequisites and setup](docs/1-prerequisites-and-setup.md) section. | ||
## Overview | ||
|
||
## Tutorial Steps | ||
This tutorial demonstrates how to create a basic API for a todo list using | ||
LoopBack 4. | ||
|
||
1. [Prerequisites and setup](docs/1-prerequisites-and-setup.md) | ||
1. [Scaffolding your application](docs/2-scaffold-app.md) | ||
1. [Adding the legacy juggler](docs/3-add-legacy-juggler.md) | ||
1. [Add your Todo model](docs/4-todo-model.md) | ||
1. [Add a datasource](docs/5-datasource.md) | ||
1. [Add a repository](docs/6-repository.md) | ||
1. [Add a controller](docs/7-controller.md) | ||
1. [Putting it all together](docs/8-putting-it-together.md) | ||
## Setup | ||
|
||
You'll need to make sure you have some things installed: | ||
- [Node.js](https://nodejs.org/en/) at v8.x or greater | ||
|
||
Additionally, this tutorial assumes that you are comfortable with | ||
certain technologies, languages and concepts. | ||
- JavaScript (ES6) | ||
- [REST](http://www.restapitutorial.com/lessons/whatisrest.html) | ||
|
||
|
||
Lastly, you'll need to install the LoopBack 4 CLI toolkit: | ||
``` | ||
npm i -g @loopback/cli | ||
``` | ||
|
||
## Tutorial | ||
|
||
To follow this tutorial, begin with the | ||
[Create your app scaffolding](docs/scaffolding.md) section. | ||
|
||
### Steps | ||
|
||
1. [Create your app scaffolding](docs/scaffolding.md) | ||
1. [Adding the legacy juggler](docs/juggler.md) | ||
1. [Add your Todo model](docs/model.md) | ||
1. [Add a datasource](docs/datasource.md) | ||
1. [Add a repository](docs/repository.md) | ||
1. [Add a controller](docs/controller.md) | ||
1. [Putting it all together](docs/putting-it-together.md) | ||
|
||
## Try it out | ||
If you'd like to see the final results of this tutorial as an example | ||
application, follow these steps: | ||
|
||
1. Run the `lb4 example` command to select and clone the getting-started repository: | ||
``` | ||
$ lb4 example | ||
? What example would you like to clone? (Use arrow keys) | ||
❯ getting-started: An application and tutorial on how to build with LoopBack 4. | ||
hello-world: A simple hello-world Application using LoopBack 4 | ||
log-extension: An example extension project for LoopBack 4 | ||
rpc-server: A basic RPC server using a made-up protocol. | ||
``` | ||
|
||
2. Jump into the directory and then install the required dependencies: | ||
``` | ||
$ cd loopback4-example-getting-started && npm i | ||
``` | ||
|
||
3. Finally, start the application! | ||
``` | ||
$ npm start | ||
|
||
Server is running on port 3000 | ||
``` | ||
|
||
Feel free to look around in the application's code to get a feel for how it | ||
works, or if you're still interested in learning how to build it step-by-step, | ||
then continue with this tutorial! | ||
|
||
### Stuck? | ||
Check out our [Gitter channel](https://gitter.im/strongloop/loopback) and ask | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I can't leave comments for things that are not changed, but for |
||
for help with this tutorial! | ||
|
||
### Bugs/Feedback | ||
Open an issue in this repository **OR** on [loopback-next](https://github.com/strongloop/loopback-next) and we'll take a look! | ||
Open an issue in [loopback-next](https://github.com/strongloop/loopback-next) | ||
and we'll take a look! |
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be JavaScript or TypeScript?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
JavaScript.
You can get away with not knowing TypeScript for this tutorial, since we give you complete working examples. Not knowing JavaScript could be a bit more problematic for consuming this tutorial.