diff --git a/CODEOWNERS b/CODEOWNERS index ca453afd754a..5e1cf86d2e7d 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -12,7 +12,7 @@ packages/build/* @bajtos @raymondfeng packages/cli/* @raymondfeng @shimks packages/context/* @bajtos @raymondfeng packages/core/* @bajtos @raymondfeng -packages/example-getting-started/* @bajtos +packages/example-todo/* @bajtos @virkt25 packages/example-hello-world/* @b-admike packages/example-log-extension/* @virkt25 packages/example-rpc-server/* @virkt25 diff --git a/docs/site/Crafting-LoopBack-4.md b/docs/site/Crafting-LoopBack-4.md index 5a2c40d72e17..e13936588ec6 100644 --- a/docs/site/Crafting-LoopBack-4.md +++ b/docs/site/Crafting-LoopBack-4.md @@ -502,7 +502,7 @@ LoopBack 4. ### Intermediate example -[@loopback/example-log-getting-started](https://github.com/strongloop/loopback-next/tree/master/packages/example-getting-started) +[@loopback/example-todo](https://github.com/strongloop/loopback-next/tree/master/packages/example-todo) ## Example for extension developers diff --git a/docs/site/Defining-the-API-using-code-first-approach.md b/docs/site/Defining-the-API-using-code-first-approach.md index 7138f856ca60..f09a89c15ae4 100644 --- a/docs/site/Defining-the-API-using-code-first-approach.md +++ b/docs/site/Defining-the-API-using-code-first-approach.md @@ -47,7 +47,7 @@ manipulation of models and their properties, they will be the first to be defined. {% include note.html content=" `Todo` model from -[tutorial](https://github.com/strongloop/loopback-next/blob/master/packages/example-getting-started/docs/model.md#srcmodelstodomodelts) +[tutorial](https://github.com/strongloop/loopback-next/blob/master/packages/example-todo/docs/model.md#srcmodelstodomodelts) is used for demonstration here. " %} First, write a simple TypeScript class describing your model and its properties: @@ -97,7 +97,7 @@ export class Todo { ### Define your routes {% include note.html content=" `TodoController` from -[tutorial](https://github.com/strongloop/loopback-next/blob/master/packages/example-getting-started/docs/controller.md#srccontrollerstodocontrollerts-2) +[tutorial](https://github.com/strongloop/loopback-next/blob/master/packages/example-todo/docs/controller.md#srccontrollerstodocontrollerts-2) is used for demonstration here. " %} Once your models are defined, create a controller to host your routes for each @@ -169,7 +169,7 @@ the `getApiSpec()` function from your `RestServer` instance. For a complete walkthrough of developing an application with the bottom-up approach, see our -[Todo application](https://github.com/strongloop/loopback-next/blob/master/packages/example-getting-started/README.md#loopbackexample-getting-started) +[Todo application](https://github.com/strongloop/loopback-next/blob/master/packages/example-todo/README.md) tutorial. {% include note.html content=" If you would like to create your API manually or diff --git a/docs/site/Download-examples.md b/docs/site/Download-examples.md index e1d8c1dabc63..e45658ef67db 100644 --- a/docs/site/Download-examples.md +++ b/docs/site/Download-examples.md @@ -39,5 +39,5 @@ The tool will prompt you for: ### Output The example project is downloaded to a new directory. For example, when -downloading `getting-started` example, the tool stores the files under the newly -created `loopback4-example-getting-started` directory. +downloading `todo` example, the tool stores the files under the newly +created `loopback4-example-todo` directory. diff --git a/docs/site/Examples-and-tutorials.md b/docs/site/Examples-and-tutorials.md index 74ff2e5f89ba..c4500422b7c0 100644 --- a/docs/site/Examples-and-tutorials.md +++ b/docs/site/Examples-and-tutorials.md @@ -13,7 +13,7 @@ LoopBack 4 comes with the following example projects: - **[hello-world](https://github.com/strongloop/loopback-next/tree/master/packages/example-hello-world)**: Tutorial on setting up a simple hello-world application using LoopBack 4. -- **[getting-started](https://github.com/strongloop/loopback-next/tree/master/packages/example-getting-started)**: +- **[todo](https://loopback.io/doc/en/lb4/todo-tutorial.html)**: Tutorial on building a simple application with LoopBack 4 key concepts using bottom-up approach. @@ -28,7 +28,7 @@ You can download any of the example projects usig our CLI tool `lb4`: ```sh 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. +❯ todo: Tutorial example on how to build an application 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. diff --git a/docs/site/MONOREPO.md b/docs/site/MONOREPO.md index a6e68925a07f..da13cf41282b 100644 --- a/docs/site/MONOREPO.md +++ b/docs/site/MONOREPO.md @@ -13,7 +13,7 @@ The [loopback-next](https://github.com/strongloop/loopback-next) repository uses | [cli](packages/cli) | @loopback/cli | CLI for LoopBack 4 | | [context](packages/context) | @loopback/context | Facilities to manage artifacts and their dependencies in your Node.js applications. The module exposes TypeScript/JavaScript APIs and decorators to register artifacts, declare dependencies, and resolve artifacts by keys. It also serves as an IoC container to support dependency injection. | | [core](packages/core) | @loopback/core | Define and implement core constructs such as Application and Component | -| [example-getting-started](packages/example-getting-started) | _(private)_ | A basic tutorial for getting started with Loopback 4 | +| [example-todo](packages/example-todo) | _(private)_ | A basic tutorial for getting started with Loopback 4 | | [example-hello-world](packages/example-hello-world) | _(private)_ | A simple hello-world application using LoopBack 4 | | [example-log-extension](packages/example-log-extension) | _(private)_ | An example showing how to write a complex log extension for LoopBack 4 | | [example-rpc-server](packages/example-rpc-server) | _(private)_ | An example RPC server and application to demonstrate the creation of your own custom server | diff --git a/docs/site/Preparing-the-API-for-consumption.md b/docs/site/Preparing-the-API-for-consumption.md index 5da3f720fce1..095e897b7a15 100644 --- a/docs/site/Preparing-the-API-for-consumption.md +++ b/docs/site/Preparing-the-API-for-consumption.md @@ -16,15 +16,15 @@ from [Implementing features](./Implementing-features.md). " %} ### Interacting with your API We'll use the repo -[loopback4-example-getting-started](https://github.com/strongloop/loopback4-example-getting-started) +[loopback4-example-todo](https://github.com/strongloop/loopback-next/blob/master/packages/example-todo) to demonstrate how Swagger UI can be used to test your endpoints. First, git clone the repository, install its dependencies, and run the application: ```sh -git clone https://github.com/strongloop/loopback4-example-getting-started -cd loopback4-example-getting-started +lb4 example todo +cd loopback4-example-todo npm i npm start ``` diff --git a/docs/site/sidebars/lb4_sidebar.yml b/docs/site/sidebars/lb4_sidebar.yml index 31673bff53a6..bf93c9223902 100644 --- a/docs/site/sidebars/lb4_sidebar.yml +++ b/docs/site/sidebars/lb4_sidebar.yml @@ -16,10 +16,42 @@ children: output: 'web, pdf' children: - - title: 'Examples and tutorials' - url: Examples-and-tutorials.html +- title: 'Examples and tutorials' + url: Examples-and-tutorials.html + output: 'web, pdf' + + - title: 'Todo Tutorial' + url: todo-tutorial.html output: 'web, pdf' + - title: 'Create your app scaffolding' + url: 'todo-tutorial/create-app-scaffolding.html' + output: 'web, pdf' + + - title: 'Adding legacy juggler' + url: 'todo-tutorial/adding-legacy-juggler.html' + output: 'web, pdf' + + - title: 'Add your Todo model' + url: 'todo-tutorial/add-todo-model.html' + output: 'web, pdf' + + - title: 'Add a Datasource' + url: 'todo-tutorial/add-datasource.html' + output: 'web, pdf' + + - title: 'Add a Repository' + url: 'todo-tutorial/add-repository.html' + output: 'web, pdf' + + - title: 'Add a Controller' + url: 'todo-tutorial/add-controller.html' + output: 'web, pdf' + + - title: 'Putting it all together' + url: 'todo-tutorial/putting-it-all-together.html' + output: 'web, pdf' + - title: 'Key concepts' url: Concepts.html output: 'web, pdf' diff --git a/docs/site/todo-tutorial/add-controller.md b/docs/site/todo-tutorial/add-controller.md new file mode 100644 index 000000000000..14b8dfbbba9e --- /dev/null +++ b/docs/site/todo-tutorial/add-controller.md @@ -0,0 +1,12 @@ +--- +lang: en +title: 'Add a Controller' +keywords: LoopBack 4.0, LoopBack 4 +layout: readme +source: loopback-next +file: packages/example-todo/docs/add-controller.md +tags: +sidebar: lb4_sidebar +permalink: /doc/en/lb4/todo-tutorial/add-controller.html +summary: LoopBack 4 Todo Application Tutorial - Add a Controller +--- diff --git a/docs/site/todo-tutorial/add-datasource.md b/docs/site/todo-tutorial/add-datasource.md new file mode 100644 index 000000000000..eda820e0f502 --- /dev/null +++ b/docs/site/todo-tutorial/add-datasource.md @@ -0,0 +1,12 @@ +--- +lang: en +title: 'Add a Datasource' +keywords: LoopBack 4.0, LoopBack 4 +layout: readme +source: loopback-next +file: packages/example-todo/docs/add-datasource.md +tags: +sidebar: lb4_sidebar +permalink: /doc/en/lb4/todo-tutorial/add-datasource.html +summary: LoopBack 4 Todo Application Tutorial - Add a Datasource +--- diff --git a/docs/site/todo-tutorial/add-repository.md b/docs/site/todo-tutorial/add-repository.md new file mode 100644 index 000000000000..22514691e15d --- /dev/null +++ b/docs/site/todo-tutorial/add-repository.md @@ -0,0 +1,12 @@ +--- +lang: en +title: 'Add a Repository' +keywords: LoopBack 4.0, LoopBack 4 +layout: readme +source: loopback-next +file: packages/example-todo/docs/add-repository.md +tags: +sidebar: lb4_sidebar +permalink: /doc/en/lb4/todo-tutorial/add-repository.html +summary: LoopBack 4 Todo Application Tutorial - Add a Repository +--- diff --git a/docs/site/todo-tutorial/add-todo-model.md b/docs/site/todo-tutorial/add-todo-model.md new file mode 100644 index 000000000000..4c35c6c86428 --- /dev/null +++ b/docs/site/todo-tutorial/add-todo-model.md @@ -0,0 +1,12 @@ +--- +lang: en +title: 'Add Todo Model' +keywords: LoopBack 4.0, LoopBack 4 +layout: readme +source: loopback-next +file: packages/example-todo/docs/add-todo-model.md +tags: +sidebar: lb4_sidebar +permalink: /doc/en/lb4/todo-tutorial/add-todo-model.html +summary: LoopBack 4 Todo Application Tutorial - Add Todo Model +--- diff --git a/docs/site/todo-tutorial/adding-legacy-juggler.md b/docs/site/todo-tutorial/adding-legacy-juggler.md new file mode 100644 index 000000000000..e4fcece4bfa5 --- /dev/null +++ b/docs/site/todo-tutorial/adding-legacy-juggler.md @@ -0,0 +1,12 @@ +--- +lang: en +title: 'Add legacy juggler' +keywords: LoopBack 4.0, LoopBack 4 +layout: readme +source: loopback-next +file: packages/example-todo/docs/adding-legacy-juggler.md +tags: +sidebar: lb4_sidebar +permalink: /doc/en/lb4/todo-tutorial/adding-legacy-juggler.html +summary: LoopBack 4 Todo Application Tutorial - Adding legacy juggler +--- diff --git a/docs/site/todo-tutorial/create-app-scaffolding.md b/docs/site/todo-tutorial/create-app-scaffolding.md new file mode 100644 index 000000000000..f038f6761af1 --- /dev/null +++ b/docs/site/todo-tutorial/create-app-scaffolding.md @@ -0,0 +1,12 @@ +--- +lang: en +title: 'Create app scaffolding' +keywords: LoopBack 4.0, LoopBack 4 +layout: readme +source: loopback-next +file: packages/example-todo/docs/create-app-scaffolding.md +tags: +sidebar: lb4_sidebar +permalink: /doc/en/lb4/todo-tutorial/create-app-scaffolding.html +summary: LoopBack 4 Todo Application Tutorial - Create app scaffolding +--- diff --git a/docs/site/todo-tutorial/putting-it-all-together.md b/docs/site/todo-tutorial/putting-it-all-together.md new file mode 100644 index 000000000000..2ee5b2c788ca --- /dev/null +++ b/docs/site/todo-tutorial/putting-it-all-together.md @@ -0,0 +1,12 @@ +--- +lang: en +title: 'Putting it all together' +keywords: LoopBack 4.0, LoopBack 4 +layout: readme +source: loopback-next +file: packages/example-todo/docs/putting-it-all-together.md +tags: +sidebar: lb4_sidebar +permalink: /doc/en/lb4/todo-tutorial/putting-it-all-together.html +summary: LoopBack 4 Todo Application Tutorial - Putting it all together +--- diff --git a/docs/site/todo-tutorial/todo-tutorial.md b/docs/site/todo-tutorial/todo-tutorial.md new file mode 100644 index 000000000000..779b77076947 --- /dev/null +++ b/docs/site/todo-tutorial/todo-tutorial.md @@ -0,0 +1,12 @@ +--- +lang: en +title: 'Todo tutorial' +keywords: LoopBack 4.0, LoopBack 4 +layout: readme +source: loopback-next +file: packages/example-todo/README.md +tags: +sidebar: lb4_sidebar +permalink: /doc/en/lb4/todo-tutorial.html +summary: LoopBack 4 Todo Application Tutorial +--- diff --git a/packages/cli/generators/example/index.js b/packages/cli/generators/example/index.js index bf96bd6c1c67..d83fa861eab7 100644 --- a/packages/cli/generators/example/index.js +++ b/packages/cli/generators/example/index.js @@ -12,8 +12,7 @@ const path = require('path'); const utils = require('../../lib/utils'); const EXAMPLES = { - 'getting-started': - 'An application and tutorial on how to build with LoopBack 4.', + todo: 'Tutorial example on how to build an application 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.', diff --git a/packages/cli/test/clone-example.test.js b/packages/cli/test/clone-example.test.js index 7ed437505c79..8fb41506f2d6 100644 --- a/packages/cli/test/clone-example.test.js +++ b/packages/cli/test/clone-example.test.js @@ -16,7 +16,7 @@ const path = require('path'); const readFile = promisify(fs.readFile); -const VALID_EXAMPLE = 'getting-started'; +const VALID_EXAMPLE = 'todo'; const SANDBOX_PATH = path.resolve(__dirname, '..', '.sandbox'); const sandbox = new TestSandbox(SANDBOX_PATH); diff --git a/packages/cli/test/example.test.js b/packages/cli/test/example.test.js index 004be1731989..069bd29e620e 100644 --- a/packages/cli/test/example.test.js +++ b/packages/cli/test/example.test.js @@ -15,7 +15,7 @@ const baseTests = require('./base-generator')(generator); const testUtils = require('./test-utils'); const ALL_EXAMPLES = require('../generators/example').getAllExamples(); -const VALID_EXAMPLE = 'getting-started'; +const VALID_EXAMPLE = 'todo'; describe('lb4 example', function() { this.timeout(10000); diff --git a/packages/example-log-extension/README.md b/packages/example-log-extension/README.md index b78348aae170..0ec5cf7a1831 100644 --- a/packages/example-log-extension/README.md +++ b/packages/example-log-extension/README.md @@ -63,7 +63,7 @@ You can obtain a local clone of this project (without the rest of our monorepo) using the following command: ```sh -lb4 example getting-started +lb4 example todo ``` ## Tutorial diff --git a/packages/example-rpc-server/index.d.ts b/packages/example-rpc-server/index.d.ts index 13ed083fde3a..7186fd6eda1a 100644 --- a/packages/example-rpc-server/index.d.ts +++ b/packages/example-rpc-server/index.d.ts @@ -1,5 +1,5 @@ // Copyright IBM Corp. 2017,2018. All Rights Reserved. -// Node module: @loopback/example-getting-started +// Node module: @loopback/example-rpc-server // This file is licensed under the MIT License. // License text available at https://opensource.org/licenses/MIT diff --git a/packages/example-rpc-server/index.js b/packages/example-rpc-server/index.js index e56e2e2405c0..30fc85896d4f 100644 --- a/packages/example-rpc-server/index.js +++ b/packages/example-rpc-server/index.js @@ -1,5 +1,5 @@ // Copyright IBM Corp. 2017,2018. All Rights Reserved. -// Node module: @loopback/example-getting-started +// Node module: @loopback/example-rpc-server // This file is licensed under the MIT License. // License text available at https://opensource.org/licenses/MIT diff --git a/packages/example-getting-started/.npmrc b/packages/example-todo/.npmrc similarity index 100% rename from packages/example-getting-started/.npmrc rename to packages/example-todo/.npmrc diff --git a/packages/example-getting-started/CHANGELOG.md b/packages/example-todo/CHANGELOG.md similarity index 100% rename from packages/example-getting-started/CHANGELOG.md rename to packages/example-todo/CHANGELOG.md diff --git a/packages/example-getting-started/LICENSE b/packages/example-todo/LICENSE similarity index 96% rename from packages/example-getting-started/LICENSE rename to packages/example-todo/LICENSE index f078f3676325..fa33ca559d95 100644 --- a/packages/example-getting-started/LICENSE +++ b/packages/example-todo/LICENSE @@ -1,5 +1,5 @@ Copyright (c) IBM Corp. 2017,2018. All Rights Reserved. -Node module: @loopback/example-getting-started +Node module: @loopback/example-todo This project is licensed under the MIT License, full text below. -------- diff --git a/packages/example-getting-started/README.md b/packages/example-todo/README.md similarity index 88% rename from packages/example-getting-started/README.md rename to packages/example-todo/README.md index b48c2f2e2e92..a9e5624735c0 100644 --- a/packages/example-getting-started/README.md +++ b/packages/example-todo/README.md @@ -1,4 +1,4 @@ -# @loopback/example-getting-started +# @loopback/example-todo This is the basic tutorial for getting started with Loopback 4! @@ -33,7 +33,7 @@ To follow this tutorial, begin with the ### Steps 1. [Create your app scaffolding](docs/scaffolding.md) -2. [Adding the legacy juggler](docs/juggler.md) +2. [Adding legacy juggler](docs/juggler.md) 3. [Add your Todo model](docs/model.md) 4. [Add a datasource](docs/datasource.md) 5. [Add a repository](docs/repository.md) @@ -45,13 +45,12 @@ To follow this tutorial, begin with the 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: +1. Run the `lb4 example` command to select and clone the todo repository: ```sh $ 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. +❯ todo: Tutorial example on how to build an application 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. @@ -60,7 +59,7 @@ $ lb4 example 2. Jump into the directory and then install the required dependencies: ```sh -cd loopback4-example-getting-started && npm i +cd loopback4-example-todo && npm i ``` 3. Finally, start the application! diff --git a/packages/example-getting-started/config/datasources.json b/packages/example-todo/config/datasources.json similarity index 100% rename from packages/example-getting-started/config/datasources.json rename to packages/example-todo/config/datasources.json diff --git a/packages/example-getting-started/data/db.json b/packages/example-todo/data/db.json similarity index 100% rename from packages/example-getting-started/data/db.json rename to packages/example-todo/data/db.json diff --git a/packages/example-getting-started/docs/controller.md b/packages/example-todo/docs/controller.md similarity index 100% rename from packages/example-getting-started/docs/controller.md rename to packages/example-todo/docs/controller.md diff --git a/packages/example-getting-started/docs/datasource.md b/packages/example-todo/docs/datasource.md similarity index 100% rename from packages/example-getting-started/docs/datasource.md rename to packages/example-todo/docs/datasource.md diff --git a/packages/example-getting-started/docs/juggler.md b/packages/example-todo/docs/juggler.md similarity index 98% rename from packages/example-getting-started/docs/juggler.md rename to packages/example-todo/docs/juggler.md index 15a14fb93321..92285f8a8229 100644 --- a/packages/example-getting-started/docs/juggler.md +++ b/packages/example-todo/docs/juggler.md @@ -1,4 +1,4 @@ -### Adding the Legacy Juggler +### Adding Legacy Juggler The Legacy Juggler is a "bridge" between the existing [loopback-datasource-juggler](https://github.com/strongloop/loopback-datasource-juggler) diff --git a/packages/example-getting-started/docs/model.md b/packages/example-todo/docs/model.md similarity index 100% rename from packages/example-getting-started/docs/model.md rename to packages/example-todo/docs/model.md diff --git a/packages/example-getting-started/docs/putting-it-together.md b/packages/example-todo/docs/putting-it-together.md similarity index 100% rename from packages/example-getting-started/docs/putting-it-together.md rename to packages/example-todo/docs/putting-it-together.md diff --git a/packages/example-getting-started/docs/repository.md b/packages/example-todo/docs/repository.md similarity index 100% rename from packages/example-getting-started/docs/repository.md rename to packages/example-todo/docs/repository.md diff --git a/packages/example-getting-started/docs/scaffolding.md b/packages/example-todo/docs/scaffolding.md similarity index 100% rename from packages/example-getting-started/docs/scaffolding.md rename to packages/example-todo/docs/scaffolding.md diff --git a/packages/example-getting-started/index.d.ts b/packages/example-todo/index.d.ts similarity index 79% rename from packages/example-getting-started/index.d.ts rename to packages/example-todo/index.d.ts index 13ed083fde3a..e6b3921eb310 100644 --- a/packages/example-getting-started/index.d.ts +++ b/packages/example-todo/index.d.ts @@ -1,5 +1,5 @@ // Copyright IBM Corp. 2017,2018. All Rights Reserved. -// Node module: @loopback/example-getting-started +// Node module: @loopback/example-todo // This file is licensed under the MIT License. // License text available at https://opensource.org/licenses/MIT diff --git a/packages/example-getting-started/index.js b/packages/example-todo/index.js similarity index 89% rename from packages/example-getting-started/index.js rename to packages/example-todo/index.js index e56e2e2405c0..cad40880d60d 100644 --- a/packages/example-getting-started/index.js +++ b/packages/example-todo/index.js @@ -1,5 +1,5 @@ // Copyright IBM Corp. 2017,2018. All Rights Reserved. -// Node module: @loopback/example-getting-started +// Node module: @loopback/example-todo // This file is licensed under the MIT License. // License text available at https://opensource.org/licenses/MIT diff --git a/packages/example-getting-started/index.ts b/packages/example-todo/index.ts similarity index 84% rename from packages/example-getting-started/index.ts rename to packages/example-todo/index.ts index fc451c4d1345..81b598876805 100644 --- a/packages/example-getting-started/index.ts +++ b/packages/example-todo/index.ts @@ -1,5 +1,5 @@ // Copyright IBM Corp. 2017,2018. All Rights Reserved. -// Node module: @loopback/example-getting-started +// Node module: @loopback/example-todo // This file is licensed under the MIT License. // License text available at https://opensource.org/licenses/MIT diff --git a/packages/example-getting-started/package.json b/packages/example-todo/package.json similarity index 79% rename from packages/example-getting-started/package.json rename to packages/example-todo/package.json index c3361193ef0b..eca402feddc9 100644 --- a/packages/example-getting-started/package.json +++ b/packages/example-todo/package.json @@ -1,7 +1,7 @@ { - "name": "@loopback/example-getting-started", + "name": "@loopback/example-todo", "version": "0.4.1", - "description": "An application and tutorial on how to build with LoopBack 4.", + "description": "Tutorial example on how to build an application with LoopBack 4.", "private": true, "main": "index.js", "engines": { @@ -11,12 +11,12 @@ "acceptance": "lb-mocha \"DIST/test/acceptance/**/*.js\"", "build": "lb-tsc es2017", "build:apidocs": "lb-apidocs", - "clean": "lb-clean *example-getting-started*.tgz dist package api-docs", + "clean": "lb-clean *example-todo*.tgz dist package api-docs", "prepublishOnly": "npm run build && npm run build:apidocs", "pretest": "npm run build", "test": "lb-mocha \"DIST/test/unit/**/*.js\" \"DIST/test/acceptance/**/*.js\"", "unit": "lb-mocha \"DIST/test/unit/**/*.js\"", - "verify": "npm pack && tar xf loopback-getting-started*.tgz && tree package && npm run clean", + "verify": "npm pack && tar xf loopback-todo*.tgz && tree package && npm run clean", "start": "npm run build && node ." }, "repository": { diff --git a/packages/example-getting-started/src/application.ts b/packages/example-todo/src/application.ts similarity index 97% rename from packages/example-getting-started/src/application.ts rename to packages/example-todo/src/application.ts index 57d1f4da7104..72deefb760f2 100644 --- a/packages/example-getting-started/src/application.ts +++ b/packages/example-todo/src/application.ts @@ -1,5 +1,5 @@ // Copyright IBM Corp. 2017,2018. All Rights Reserved. -// Node module: @loopback/example-getting-started +// Node module: @loopback/example-todo // This file is licensed under the MIT License. // License text available at https://opensource.org/licenses/MIT diff --git a/packages/example-getting-started/src/controllers/index.ts b/packages/example-todo/src/controllers/index.ts similarity index 80% rename from packages/example-getting-started/src/controllers/index.ts rename to packages/example-todo/src/controllers/index.ts index 10f6afeed69b..84405e46e6a4 100644 --- a/packages/example-getting-started/src/controllers/index.ts +++ b/packages/example-todo/src/controllers/index.ts @@ -1,5 +1,5 @@ // Copyright IBM Corp. 2017,2018. All Rights Reserved. -// Node module: @loopback/example-getting-started +// Node module: @loopback/example-todo // This file is licensed under the MIT License. // License text available at https://opensource.org/licenses/MIT diff --git a/packages/example-getting-started/src/controllers/todo.controller.ts b/packages/example-todo/src/controllers/todo.controller.ts similarity index 91% rename from packages/example-getting-started/src/controllers/todo.controller.ts rename to packages/example-todo/src/controllers/todo.controller.ts index 9e3a5c368705..a1a8a1955e2a 100644 --- a/packages/example-getting-started/src/controllers/todo.controller.ts +++ b/packages/example-todo/src/controllers/todo.controller.ts @@ -1,3 +1,8 @@ +// Copyright IBM Corp. 2017,2018. All Rights Reserved. +// Node module: @loopback/example-todo +// This file is licensed under the MIT License. +// License text available at https://opensource.org/licenses/MIT + import {repository} from '@loopback/repository'; import {TodoRepository} from '../repositories'; import {Todo} from '../models'; diff --git a/packages/example-getting-started/src/datasources/db.datasource.ts b/packages/example-todo/src/datasources/db.datasource.ts similarity index 95% rename from packages/example-getting-started/src/datasources/db.datasource.ts rename to packages/example-todo/src/datasources/db.datasource.ts index 7091892f1172..ed9d2b2214c4 100644 --- a/packages/example-getting-started/src/datasources/db.datasource.ts +++ b/packages/example-todo/src/datasources/db.datasource.ts @@ -1,5 +1,5 @@ // Copyright IBM Corp. 2017,2018. All Rights Reserved. -// Node module: @loopback/example-getting-started +// Node module: @loopback/example-todo // This file is licensed under the MIT License. // License text available at https://opensource.org/licenses/MIT diff --git a/packages/example-getting-started/src/index.ts b/packages/example-todo/src/index.ts similarity index 92% rename from packages/example-getting-started/src/index.ts rename to packages/example-todo/src/index.ts index cd738a1596f3..9b63ffa980c7 100644 --- a/packages/example-getting-started/src/index.ts +++ b/packages/example-todo/src/index.ts @@ -1,5 +1,5 @@ // Copyright IBM Corp. 2017,2018. All Rights Reserved. -// Node module: @loopback/example-getting-started +// Node module: @loopback/example-todo // This file is licensed under the MIT License. // License text available at https://opensource.org/licenses/MIT diff --git a/packages/example-getting-started/src/models/index.ts b/packages/example-todo/src/models/index.ts similarity index 79% rename from packages/example-getting-started/src/models/index.ts rename to packages/example-todo/src/models/index.ts index d7c59a40ea98..fbcc34a61667 100644 --- a/packages/example-getting-started/src/models/index.ts +++ b/packages/example-todo/src/models/index.ts @@ -1,5 +1,5 @@ // Copyright IBM Corp. 2017,2018. All Rights Reserved. -// Node module: @loopback/example-getting-started +// Node module: @loopback/example-todo // This file is licensed under the MIT License. // License text available at https://opensource.org/licenses/MIT diff --git a/packages/example-getting-started/src/models/todo.model.ts b/packages/example-todo/src/models/todo.model.ts similarity index 66% rename from packages/example-getting-started/src/models/todo.model.ts rename to packages/example-todo/src/models/todo.model.ts index 010740f4025e..c17b130d8430 100644 --- a/packages/example-getting-started/src/models/todo.model.ts +++ b/packages/example-todo/src/models/todo.model.ts @@ -1,3 +1,8 @@ +// Copyright IBM Corp. 2017,2018. All Rights Reserved. +// Node module: @loopback/example-todo +// This file is licensed under the MIT License. +// License text available at https://opensource.org/licenses/MIT + import {Entity, property, model} from '@loopback/repository'; @model() diff --git a/packages/example-getting-started/src/repositories/index.ts b/packages/example-todo/src/repositories/index.ts similarity index 80% rename from packages/example-getting-started/src/repositories/index.ts rename to packages/example-todo/src/repositories/index.ts index 148a9fba5b74..fa62ba7c2e97 100644 --- a/packages/example-getting-started/src/repositories/index.ts +++ b/packages/example-todo/src/repositories/index.ts @@ -1,5 +1,5 @@ // Copyright IBM Corp. 2017,2018. All Rights Reserved. -// Node module: @loopback/example-getting-started +// Node module: @loopback/example-todo // This file is licensed under the MIT License. // License text available at https://opensource.org/licenses/MIT diff --git a/packages/example-getting-started/src/repositories/todo.repository.ts b/packages/example-todo/src/repositories/todo.repository.ts similarity index 91% rename from packages/example-getting-started/src/repositories/todo.repository.ts rename to packages/example-todo/src/repositories/todo.repository.ts index 081112991424..292cea2199ba 100644 --- a/packages/example-getting-started/src/repositories/todo.repository.ts +++ b/packages/example-todo/src/repositories/todo.repository.ts @@ -1,5 +1,5 @@ // Copyright IBM Corp. 2017,2018. All Rights Reserved. -// Node module: @loopback/example-getting-started +// Node module: @loopback/example-todo // This file is licensed under the MIT License. // License text available at https://opensource.org/licenses/MIT diff --git a/packages/example-getting-started/src/sequence.ts b/packages/example-todo/src/sequence.ts similarity index 83% rename from packages/example-getting-started/src/sequence.ts rename to packages/example-todo/src/sequence.ts index 962946f894ce..55f2eb029e03 100644 --- a/packages/example-getting-started/src/sequence.ts +++ b/packages/example-todo/src/sequence.ts @@ -1,3 +1,8 @@ +// Copyright IBM Corp. 2017,2018. All Rights Reserved. +// Node module: @loopback/example-todo +// This file is licensed under the MIT License. +// License text available at https://opensource.org/licenses/MIT + import {Context, inject} from '@loopback/context'; import { FindRoute, diff --git a/packages/example-getting-started/test/acceptance/application.test.ts b/packages/example-todo/test/acceptance/application.test.ts similarity index 94% rename from packages/example-getting-started/test/acceptance/application.test.ts rename to packages/example-todo/test/acceptance/application.test.ts index fba79c552a2b..9ddd237598a5 100644 --- a/packages/example-getting-started/test/acceptance/application.test.ts +++ b/packages/example-todo/test/acceptance/application.test.ts @@ -1,3 +1,8 @@ +// Copyright IBM Corp. 2017,2018. All Rights Reserved. +// Node module: @loopback/example-todo +// This file is licensed under the MIT License. +// License text available at https://opensource.org/licenses/MIT + import {createClientForHandler, expect, supertest} from '@loopback/testlab'; import {RestServer} from '@loopback/rest'; import {TodoListApplication} from '../../src/application'; diff --git a/packages/example-getting-started/test/helpers.ts b/packages/example-todo/test/helpers.ts similarity index 85% rename from packages/example-getting-started/test/helpers.ts rename to packages/example-todo/test/helpers.ts index a14e478f01f8..618882fd3ed0 100644 --- a/packages/example-getting-started/test/helpers.ts +++ b/packages/example-todo/test/helpers.ts @@ -1,3 +1,8 @@ +// Copyright IBM Corp. 2017,2018. All Rights Reserved. +// Node module: @loopback/example-todo +// This file is licensed under the MIT License. +// License text available at https://opensource.org/licenses/MIT + import {Todo} from '../src/models/index'; /* @@ -8,7 +13,7 @@ import {Todo} from '../src/models/index'; way to reduce duplication. Other tips: - + - Using the super awesome Partial type in conjunction with Object.assign means you can: * customize the object you get back based only on what's important diff --git a/packages/example-getting-started/test/unit/controllers/todo.controller.test.ts b/packages/example-todo/test/unit/controllers/todo.controller.test.ts similarity index 95% rename from packages/example-getting-started/test/unit/controllers/todo.controller.test.ts rename to packages/example-todo/test/unit/controllers/todo.controller.test.ts index f86329b11b6f..6eb4544cef50 100644 --- a/packages/example-getting-started/test/unit/controllers/todo.controller.test.ts +++ b/packages/example-todo/test/unit/controllers/todo.controller.test.ts @@ -1,3 +1,8 @@ +// Copyright IBM Corp. 2017,2018. All Rights Reserved. +// Node module: @loopback/example-todo +// This file is licensed under the MIT License. +// License text available at https://opensource.org/licenses/MIT + import {expect, sinon} from '@loopback/testlab'; import {TodoController} from '../../../src/controllers'; import {TodoRepository} from '../../../src/repositories'; diff --git a/packages/example-getting-started/tsconfig.build.json b/packages/example-todo/tsconfig.build.json similarity index 100% rename from packages/example-getting-started/tsconfig.build.json rename to packages/example-todo/tsconfig.build.json