diff --git a/packages/example-getting-started/README.md b/packages/example-getting-started/README.md index c8eba4a84872..177887461981 100644 --- a/packages/example-getting-started/README.md +++ b/packages/example-getting-started/README.md @@ -2,6 +2,20 @@ 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. + +## Tutorial Steps + +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) + ### Stuck? Check out our [Gitter channel](https://gitter.im/strongloop/loopback) and ask for help with this tutorial! diff --git a/packages/example-getting-started/docs/1-prerequisites-and-setup.md b/packages/example-getting-started/docs/1-prerequisites-and-setup.md index cb75fb59965d..713e5c2a6e2c 100644 --- a/packages/example-getting-started/docs/1-prerequisites-and-setup.md +++ b/packages/example-getting-started/docs/1-prerequisites-and-setup.md @@ -28,3 +28,7 @@ cd loopback-example-getting-started && npm i ``` npm start ``` + +### Navigation + +Next step: [Scaffolding your application](2-scaffold-app.md) diff --git a/packages/example-getting-started/docs/2-scaffold-app.md b/packages/example-getting-started/docs/2-scaffold-app.md index edb3a160adfc..eefbd82b8013 100644 --- a/packages/example-getting-started/docs/2-scaffold-app.md +++ b/packages/example-getting-started/docs/2-scaffold-app.md @@ -11,3 +11,9 @@ not to enable certain project features (loopback's build, tslint, mocha, etc.), leave them all enabled. + +### Navigation + +Previous step: [Prerequisites and setup](1-prerequisites-and-setup.md) + +Next step: [Adding the legacy juggler](3-add-legacy-juggler.md) diff --git a/packages/example-getting-started/docs/3-add-legacy-juggler.md b/packages/example-getting-started/docs/3-add-legacy-juggler.md index e44d07de19f2..d11d7717b592 100644 --- a/packages/example-getting-started/docs/3-add-legacy-juggler.md +++ b/packages/example-getting-started/docs/3-add-legacy-juggler.md @@ -1,4 +1,4 @@ -### Adding Legacy Juggler Capabilities +### Adding the Legacy Juggler Jump into the directory for your new application. You'll see a folder structure similar to this: @@ -52,3 +52,8 @@ export class TodoApplication extends RepositoryMixin(RestApplication) { } } ``` +### Navigation + +Previous step: [Scaffolding your application](2-scaffold-app.md) + +Next step: [Add your Todo model](4-todo-model.md) diff --git a/packages/example-getting-started/docs/4-todo-model.md b/packages/example-getting-started/docs/4-todo-model.md index 408758a746a7..168312ef218d 100644 --- a/packages/example-getting-started/docs/4-todo-model.md +++ b/packages/example-getting-started/docs/4-todo-model.md @@ -102,3 +102,8 @@ export const TodoSchema: SchemaObject = { required: ['title'], }; ``` +### Navigation + +Previous step: [Adding the Legacy Juggler](3-add-legacy-juggler.md) + +Next step: [Add a datasource](5-datasource.md) diff --git a/packages/example-getting-started/docs/5-datasource.md b/packages/example-getting-started/docs/5-datasource.md index 9cc2ff210e2a..958259971413 100644 --- a/packages/example-getting-started/docs/5-datasource.md +++ b/packages/example-getting-started/docs/5-datasource.md @@ -32,3 +32,9 @@ export const db = new DataSourceConstructor(config); This will give us a strongly-typed datasource export that we can work with to construct our TodoRepository definition. + +### Navigation + +Previous step: [Add your Todo model](4-todo-model.md) + +Next step: [Add a repository](6-repository.md) diff --git a/packages/example-getting-started/docs/6-repository.md b/packages/example-getting-started/docs/6-repository.md index b2520590985a..95569abc0935 100644 --- a/packages/example-getting-started/docs/6-repository.md +++ b/packages/example-getting-started/docs/6-repository.md @@ -26,3 +26,8 @@ export class TodoRepository extends DefaultCrudRepository< } } ``` +### Navigation + +Previous step: [Add a datasource](5-datasource.md) + +Next step: [Add a controller](7-controller.md) diff --git a/packages/example-getting-started/docs/7-controller.md b/packages/example-getting-started/docs/7-controller.md index 484cd906b096..96d16354e8aa 100644 --- a/packages/example-getting-started/docs/7-controller.md +++ b/packages/example-getting-started/docs/7-controller.md @@ -63,3 +63,9 @@ export class TodoController { } } ``` + +### Navigation + +Previous step: [Add a repository](6-repository.md) + +Final step: [Putting it all together](8-putting-it-together.md) diff --git a/packages/example-getting-started/docs/8-putting-it-together.md b/packages/example-getting-started/docs/8-putting-it-together.md index 11bbac64ecfa..579af3919815 100644 --- a/packages/example-getting-started/docs/8-putting-it-together.md +++ b/packages/example-getting-started/docs/8-putting-it-together.md @@ -52,3 +52,15 @@ Start the app (`npm start`) and then make some REST requests: - `POST /todo` with a body of `{ "title": "get the milk" }` - `GET /todo/1` and see if you get your Todo object back. - `PATCH /todo/1` with a body of `{ "desc": "need milk for cereal" }` + +### Navigation + +Previous step: [Add a controller](7-controller.md) + +### More examples and tutorials + +Eager to continue learning about LoopBack 4? Check out our +[examples and tutorials](https://loopback.io/doc/en/lb4/Examples-and-tutorials.html) +section to find examples for creating your own custom components, sequences and +more! +