feat(example-greeting-app): add a new example to demonstrate loopback core

Author: raymondfeng

examples/greeting-app/.npmrc

@@ -0,0 +1 @@
+package-lock=true

examples/greeting-app/.prettierignore

@@ -0,0 +1,2 @@
+dist
+*.json

examples/greeting-app/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "bracketSpacing": false,
+  "singleQuote": true,
+  "printWidth": 80,
+  "trailingComma": "all"
+}

examples/greeting-app/.vscode/settings.json

@@ -0,0 +1,21 @@
+{
+  "editor.rulers": [80],
+  "editor.tabCompletion": "on",
+  "editor.tabSize": 2,
+  "editor.trimAutoWhitespace": true,
+  "editor.formatOnSave": true,
+
+  "files.exclude": {
+    "**/.DS_Store": true,
+    "**/.git": true,
+    "**/.hg": true,
+    "**/.svn": true,
+    "**/CVS": true,
+    "dist": true,
+  },
+  "files.insertFinalNewline": true,
+  "files.trimTrailingWhitespace": true,
+
+  "tslint.ignoreDefinitionFiles": true,
+  "typescript.tsdk": "./node_modules/typescript/lib"
+}

examples/greeting-app/.vscode/tasks.json

@@ -0,0 +1,29 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Watch and Compile Project",
+      "type": "shell",
+      "command": "npm",
+      "args": ["--silent", "run", "build:watch"],
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "problemMatcher": "$tsc-watch"
+    },
+    {
+      "label": "Build, Test and Lint",
+      "type": "shell",
+      "command": "npm",
+      "args": ["--silent", "run", "test:dev"],
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      },
+      "problemMatcher": ["$tsc", "$tslint5"]
+    }
+  ]
+}

examples/greeting-app/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) IBM Corp. 2019. All Rights Reserved.
+Node module: @loopback/example-greeting-app
+This project is licensed under the MIT License, full text below.
+
+--------
+
+MIT license
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

examples/greeting-app/README.md

@@ -0,0 +1,61 @@
+# @loopback/example-greeting-app
+
+This application is built on top of
+[`@loopback/example-greeter-extension`](https://github.com/strongloop/loopback-next/tree/master/examples/greeter-extension).
+
+## Compose the application
+
+1. Add REST API
+
+   - GreetingController - providing endpoints over `GreetingService`
+
+2. Add caching
+
+   - CachingService - implementing cache operations, such as set,get, delete,
+     and sweep
+   - CachingInterceptor - intercepting http requests to apply caching
+   - CacheObserver - watching and sweeping cache in the background
+
+![greeting-app](./greeting-app.png)
+
+## Contributions
+
+- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md)
+- [Join the team](https://github.com/strongloop/loopback-next/issues/110)
+
+## Try out
+
+Run `npm start`:
+
+The service is running at http://127.0.0.1:3000/greet/world.
+
+Open your browser to try the REST APIs. You can replace `world` with other
+names.
+
+The following `curl` command sets `Accept-Language` header to `zh` to receive
+the greeting in Chinese.
+
+```sh
+curl -H 'Accept-Language: zh' http://127.0.0.1:3000/greet/Ray
+```
+
+```json
+{
+  "timestamp": "2019-05-29T22:48:03.040Z",
+  "language": "zh",
+  "greeting": "Ray，你好！"
+}
+```
+
+## Tests
+
+Run `npm test` from the root folder.
+
+## Contributors
+
+See
+[all contributors](https://github.com/strongloop/loopback-next/graphs/contributors).
+
+## License
+
+MIT

examples/greeting-app/greeting-app.png

@@ -0,0 +1,6 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/example-greeting-app
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+export * from './dist';

examples/greeting-app/index.d.ts

@@ -0,0 +1,30 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/example-greeting-app
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+module.exports = require('./dist');
+
+async function main() {
+  const config = {
+    rest: {
+      port: +(process.env.PORT || 3000),
+      host: process.env.HOST || '127.0.0.1',
+      openApiSpec: {
+        // useful when used with OASGraph to locate your application
+        setServersFromRequest: true,
+      },
+    },
+  };
+  const app = new module.exports.GreetingApplication(config);
+  await app.main();
+  const url = app.restServer.url;
+  console.log(`The service is running at ${url}/greet/world.`);
+}
+
+if (require.main === module) {
+  main().catch(err => {
+    console.error('Cannot start the application.', err);
+    process.exit(1);
+  });
+}