diff --git a/NOTICE b/NOTICE deleted file mode 100644 index 21661b4c..00000000 --- a/NOTICE +++ /dev/null @@ -1 +0,0 @@ -Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. \ No newline at end of file diff --git a/README.md b/README.md index 035f076c..f72bd32f 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,46 @@ -# cloud-cap-samples +# Welcome to cap/samples -This is a monorepository for sample projects on [SAP Cloud Application Programming Model](https://cap.cloud.sap). +Find here code samples for the [SAP Cloud Application Programming Model](https://cap.cloud.sap) oganised in a simplistic monorepo. -## Description +## Preliminaries -This repository provides a list of samples and reusable packages created based on SAP Cloud Application Programming Model. -The SAP Cloud Application Programming Model enables you to quickly create business applications by allowing you to focus on your domain logic. It offers a consistent end-to-end programming model that includes languages, libraries and APIs tailored for full-stack development on SAP Cloud Platform. - -The samples provided can be run in a local setup on SQLite Database. +- [Install @sap/cds-dk](https://cap.cloud.sap/docs/get-started/) as documented in capire -## Requirements -* [Node.js](https://nodejs.org/en/) v8 or higher -* [Git](https://git-scm.com) -* [SQLite DB](https://www.sqlite.org/download.html) (Windows only; pre-installed on Mac/Linux) +## Download -#### Optional (if you want to import the code into an editor) -* [VS Code](https://code.visualstudio.com) -* [Add CDS extension to VS](https://cap.cloud.sap/docs/get-started/in-vscode#add-cds-editor) +Clone this repo as shown below, if you have [git](https://git-scm.com/downloads) installed, +otherwise [download as zip file](archive/master.zip). -## Download and Installation - -#### Install `cds` development kit ```sh -# `@sap`-scoped packages are set via .npmrc -npm install -g @sap/cds-dk -cds #> test-run it +git clone https://github.com/sap-samples/cap samples +cd samples ``` -Got issues? Check out the [documentation](https://cap.cloud.sap/docs/get-started/). -#### Clone and build the application -`git clone https://github.com/SAP-samples/cloud-cap-samples samples && cd samples && npm i` +## Setup -#### Run the samples +In the samples folder run: +```sh +npm install +``` -With that you're ready to run the samples, e.g. start the [_bookshop_](./packages/bookshop) sample as follows: +## Run -`npm run bookshop` +With that you're ready to run the samples, for example: +```sh +npm run bookshop # or... +npm run bookshop-fiori +``` -## Test - -For example, try these links in your browser: -- to test with generic index page. -- to test with Fiori sandbox. +After that open this link in your browser: -## Debug +## Get Support -For example, in [VS Code](https://code.visualstudio.com) switch to _Debug_ view and launch one of the prepared _cds run_ launch configurations. +Check out the cap docs at https://cap.cloud.sap.
+In case you find a bug or need support, please [open an issue in here](https://github.com/SAP-samples/cloud-cap-samples/issues/new). -## Limitations - -None - -## Known Issues - -None - -## How to obtain support - -Check out the documentation on https://cap.cloud.sap. In case you find a bug, or you need additional support, please open an issue [here](https://github.com/SAP-samples/cloud-cap-samples/issues/new) in GitHub. - -## To-Do (upcoming changes) - -None - ## License Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under SAP Sample Code License Agreement, except as noted otherwise in the [LICENSE](/LICENSE) file. diff --git a/_packages/bookshop-enhanced/app/index.cds b/_attic/bookshop-enhanced/app/index.cds similarity index 100% rename from _packages/bookshop-enhanced/app/index.cds rename to _attic/bookshop-enhanced/app/index.cds diff --git a/_packages/bookshop-enhanced/db/schema.cds b/_attic/bookshop-enhanced/db/schema.cds similarity index 100% rename from _packages/bookshop-enhanced/db/schema.cds rename to _attic/bookshop-enhanced/db/schema.cds diff --git a/_packages/bookshop-enhanced/package.json b/_attic/bookshop-enhanced/package.json similarity index 100% rename from _packages/bookshop-enhanced/package.json rename to _attic/bookshop-enhanced/package.json diff --git a/_packages/bookshop-enhanced/srv/services.cds b/_attic/bookshop-enhanced/srv/services.cds similarity index 100% rename from _packages/bookshop-enhanced/srv/services.cds rename to _attic/bookshop-enhanced/srv/services.cds diff --git a/_packages/bookshop-enhanced/srv/services.js b/_attic/bookshop-enhanced/srv/services.js similarity index 100% rename from _packages/bookshop-enhanced/srv/services.js rename to _attic/bookshop-enhanced/srv/services.js diff --git a/_packages/bookshop-enhanced/tests/genres.http b/_attic/bookshop-enhanced/tests/genres.http similarity index 100% rename from _packages/bookshop-enhanced/tests/genres.http rename to _attic/bookshop-enhanced/tests/genres.http diff --git a/_packages/bookshop-enhanced/tests/reviews.http b/_attic/bookshop-enhanced/tests/reviews.http similarity index 100% rename from _packages/bookshop-enhanced/tests/reviews.http rename to _attic/bookshop-enhanced/tests/reviews.http diff --git a/_packages/bookstore/db/data/sap.capire.bookstore-Authors.csv b/_attic/bookstore/db/data/sap.capire.bookstore-Authors.csv similarity index 100% rename from _packages/bookstore/db/data/sap.capire.bookstore-Authors.csv rename to _attic/bookstore/db/data/sap.capire.bookstore-Authors.csv diff --git a/_packages/bookstore/db/data/sap.capire.products-Categories.csv b/_attic/bookstore/db/data/sap.capire.products-Categories.csv similarity index 100% rename from _packages/bookstore/db/data/sap.capire.products-Categories.csv rename to _attic/bookstore/db/data/sap.capire.products-Categories.csv diff --git a/_packages/bookstore/db/data/sap.capire.products-Products.csv b/_attic/bookstore/db/data/sap.capire.products-Products.csv similarity index 100% rename from _packages/bookstore/db/data/sap.capire.products-Products.csv rename to _attic/bookstore/db/data/sap.capire.products-Products.csv diff --git a/_packages/bookstore/db/data/sap.capire.products-Products_texts.csv b/_attic/bookstore/db/data/sap.capire.products-Products_texts.csv similarity index 100% rename from _packages/bookstore/db/data/sap.capire.products-Products_texts.csv rename to _attic/bookstore/db/data/sap.capire.products-Products_texts.csv diff --git a/_packages/bookstore/db/schema.cds b/_attic/bookstore/db/schema.cds similarity index 100% rename from _packages/bookstore/db/schema.cds rename to _attic/bookstore/db/schema.cds diff --git a/_packages/bookstore/package.json b/_attic/bookstore/package.json similarity index 100% rename from _packages/bookstore/package.json rename to _attic/bookstore/package.json diff --git a/_packages/bookstore/srv/_workarounds.cds b/_attic/bookstore/srv/_workarounds.cds similarity index 100% rename from _packages/bookstore/srv/_workarounds.cds rename to _attic/bookstore/srv/_workarounds.cds diff --git a/_packages/bookstore/srv/services.cds b/_attic/bookstore/srv/services.cds similarity index 100% rename from _packages/bookstore/srv/services.cds rename to _attic/bookstore/srv/services.cds diff --git a/_packages/bookstore/srv/services.js b/_attic/bookstore/srv/services.js similarity index 100% rename from _packages/bookstore/srv/services.js rename to _attic/bookstore/srv/services.js diff --git a/_packages/bookstore/tests/books.cds b/_attic/bookstore/tests/books.cds similarity index 100% rename from _packages/bookstore/tests/books.cds rename to _attic/bookstore/tests/books.cds diff --git a/_packages/bookstore/tests/localized-data.test.js b/_attic/bookstore/tests/localized-data.test.js similarity index 100% rename from _packages/bookstore/tests/localized-data.test.js rename to _attic/bookstore/tests/localized-data.test.js diff --git a/_packages/common-contacts/db/code-lists.cds b/_attic/common-contacts/db/code-lists.cds similarity index 100% rename from _packages/common-contacts/db/code-lists.cds rename to _attic/common-contacts/db/code-lists.cds diff --git a/_packages/common-contacts/db/schema.cds b/_attic/common-contacts/db/schema.cds similarity index 100% rename from _packages/common-contacts/db/schema.cds rename to _attic/common-contacts/db/schema.cds diff --git a/_packages/common-contacts/index.cds b/_attic/common-contacts/index.cds similarity index 100% rename from _packages/common-contacts/index.cds rename to _attic/common-contacts/index.cds diff --git a/_packages/common-contacts/package.json b/_attic/common-contacts/package.json similarity index 100% rename from _packages/common-contacts/package.json rename to _attic/common-contacts/package.json diff --git a/_packages/common-contacts/readme.md b/_attic/common-contacts/readme.md similarity index 100% rename from _packages/common-contacts/readme.md rename to _attic/common-contacts/readme.md diff --git a/_packages/common-contacts/srv/code-lists.js b/_attic/common-contacts/srv/code-lists.js similarity index 100% rename from _packages/common-contacts/srv/code-lists.js rename to _attic/common-contacts/srv/code-lists.js diff --git a/_packages/common-contacts/tests/code-lists.test.js b/_attic/common-contacts/tests/code-lists.test.js similarity index 100% rename from _packages/common-contacts/tests/code-lists.test.js rename to _attic/common-contacts/tests/code-lists.test.js diff --git a/_packages/common-contacts/tests/index.cds b/_attic/common-contacts/tests/index.cds similarity index 100% rename from _packages/common-contacts/tests/index.cds rename to _attic/common-contacts/tests/index.cds diff --git a/_packages/media-server/db/data-model.cds b/_attic/media-server/db/data-model.cds similarity index 100% rename from _packages/media-server/db/data-model.cds rename to _attic/media-server/db/data-model.cds diff --git a/_packages/media-server/index.cds b/_attic/media-server/index.cds similarity index 100% rename from _packages/media-server/index.cds rename to _attic/media-server/index.cds diff --git a/_packages/media-server/package.json b/_attic/media-server/package.json similarity index 100% rename from _packages/media-server/package.json rename to _attic/media-server/package.json diff --git a/_packages/media-server/srv/media-service.cds b/_attic/media-server/srv/media-service.cds similarity index 100% rename from _packages/media-server/srv/media-service.cds rename to _attic/media-server/srv/media-service.cds diff --git a/_packages/media-server/srv/media-service.js b/_attic/media-server/srv/media-service.js similarity index 100% rename from _packages/media-server/srv/media-service.js rename to _attic/media-server/srv/media-service.js diff --git a/_packages/orders-service/db/data/sap.capire.orders-OrderItems.csv b/_attic/orders-service/db/data/sap.capire.orders-OrderItems.csv similarity index 100% rename from _packages/orders-service/db/data/sap.capire.orders-OrderItems.csv rename to _attic/orders-service/db/data/sap.capire.orders-OrderItems.csv diff --git a/_packages/orders-service/db/data/sap.capire.orders-Orders.csv b/_attic/orders-service/db/data/sap.capire.orders-Orders.csv similarity index 100% rename from _packages/orders-service/db/data/sap.capire.orders-Orders.csv rename to _attic/orders-service/db/data/sap.capire.orders-Orders.csv diff --git a/_packages/orders-service/db/schema.cds b/_attic/orders-service/db/schema.cds similarity index 100% rename from _packages/orders-service/db/schema.cds rename to _attic/orders-service/db/schema.cds diff --git a/_packages/orders-service/index.cds b/_attic/orders-service/index.cds similarity index 100% rename from _packages/orders-service/index.cds rename to _attic/orders-service/index.cds diff --git a/_packages/orders-service/package.json b/_attic/orders-service/package.json similarity index 100% rename from _packages/orders-service/package.json rename to _attic/orders-service/package.json diff --git a/_packages/orders-service/srv/orders-service.cds b/_attic/orders-service/srv/orders-service.cds similarity index 100% rename from _packages/orders-service/srv/orders-service.cds rename to _attic/orders-service/srv/orders-service.cds diff --git a/_packages/products-service/db/schema.cds b/_attic/products-service/db/schema.cds similarity index 100% rename from _packages/products-service/db/schema.cds rename to _attic/products-service/db/schema.cds diff --git a/_packages/products-service/index.cds b/_attic/products-service/index.cds similarity index 100% rename from _packages/products-service/index.cds rename to _attic/products-service/index.cds diff --git a/_packages/products-service/package.json b/_attic/products-service/package.json similarity index 100% rename from _packages/products-service/package.json rename to _attic/products-service/package.json diff --git a/_packages/products-service/srv/admin-service.cds b/_attic/products-service/srv/admin-service.cds similarity index 100% rename from _packages/products-service/srv/admin-service.cds rename to _attic/products-service/srv/admin-service.cds diff --git a/_packages/products-service/tests/categories.test.js b/_attic/products-service/tests/categories.test.js similarity index 100% rename from _packages/products-service/tests/categories.test.js rename to _attic/products-service/tests/categories.test.js diff --git a/_packages/products-service/tests/data/sap.capire.products-Categories.csv b/_attic/products-service/tests/data/sap.capire.products-Categories.csv similarity index 100% rename from _packages/products-service/tests/data/sap.capire.products-Categories.csv rename to _attic/products-service/tests/data/sap.capire.products-Categories.csv diff --git a/_packages/products-service/tests/postman.json b/_attic/products-service/tests/postman.json similarity index 100% rename from _packages/products-service/tests/postman.json rename to _attic/products-service/tests/postman.json diff --git a/_packages/users-service/index.cds b/_attic/users-service/index.cds similarity index 100% rename from _packages/users-service/index.cds rename to _attic/users-service/index.cds diff --git a/_packages/users-service/package.json b/_attic/users-service/package.json similarity index 100% rename from _packages/users-service/package.json rename to _attic/users-service/package.json diff --git a/_packages/users-service/srv/services.cds b/_attic/users-service/srv/services.cds similarity index 100% rename from _packages/users-service/srv/services.cds rename to _attic/users-service/srv/services.cds diff --git a/bookshop/package.json b/bookshop/package.json index e874e8df..62543c2a 100644 --- a/bookshop/package.json +++ b/bookshop/package.json @@ -4,14 +4,12 @@ "description": "A simple bookshop application, build in a self-contained all-in-one fashion, i.e. w/o reusing other packages.", "license": "SAP SAMPLE CODE LICENSE", "dependencies": { - "@capire/common": "*", - "@sap/cds": "*", - "express": "*" + "@capire/common": "*" }, "scripts": { "start": "cds run --in-memory?", "watch": "cds watch", - "test:genres": "cds serve test/genres --in-memory" + "test:genres": "cds serve tests/genres.cds --in-memory" }, "cds": { "requires": { diff --git a/bookshop/test/genres.cds b/bookshop/tests/genres.cds similarity index 100% rename from bookshop/test/genres.cds rename to bookshop/tests/genres.cds diff --git a/bookshop/test/genres.http b/bookshop/tests/genres.http similarity index 100% rename from bookshop/test/genres.http rename to bookshop/tests/genres.http diff --git a/bookshop/test/requests.http b/bookshop/tests/requests.http similarity index 100% rename from bookshop/test/requests.http rename to bookshop/tests/requests.http diff --git a/fiori/package.json b/fiori/package.json index 681e4551..5924c98d 100644 --- a/fiori/package.json +++ b/fiori/package.json @@ -5,10 +5,7 @@ "license": "SAP SAMPLE CODE LICENSE", "dependencies": { "@capire/bookshop": "*", - "@capire/genres": "*", - "@capire/common": "*", - "@sap/cds": "*", - "express": "*" + "@capire/common": "*" }, "scripts": { "start": "cds run --in-memory?", diff --git a/package.json b/package.json index 8495b2c0..dfe31f95 100644 --- a/package.json +++ b/package.json @@ -5,14 +5,15 @@ "author": "daniel.hutzel@sap.com", "private": true, "scripts": { - "bookshop": "cds watch bookshop" + "bookshop": "cds watch bookshop", + "bookshop-fiori": "cds watch fiori" }, "dependencies": { - "@capire/bookshop": "./bookshop", - "@capire/genres": "./genres", - "@capire/common": "./common" + "@capire/bookshop": "file:bookshop", + "@capire/common": "file:common", + "@capire/reviews": "file:reviews" }, - "--add-these-to-devDependencies-for-tests": { + "add-these-to-devDependencies-for-tests": { "@types/jest": "*", "jest": "*" }, diff --git a/reviews/package.json b/reviews/package.json index 990f4e35..4c7e6062 100644 --- a/reviews/package.json +++ b/reviews/package.json @@ -1,12 +1,10 @@ { - "name": "@sap/capire-reviews", + "name": "@capire/reviews", "version": "1.0.0", "description": "A reuse service providing generic means to add reviews and ratings to target objects, e.g. products.", "repository": "https://github.com/SAP-samples/cloud-cap-samples.git", "license": "SAP SAMPLE CODE LICENSE", "dependencies": { - "@sap/cds": "latest", - "express": "*" }, "scripts": { "start": "cds run --in-memory?",