minor updates
This commit is contained in:
Iwona Hahn
committed by
Christian Georgi
Christian Georgi
parent
5b966c503c
commit
6a4af929f1
17
README.md
17
README.md
@@ -8,16 +8,17 @@ Find here a collection of samples for the [SAP Cloud Application Programming Mod
|
||||
|
||||
### Preliminaries
|
||||
|
||||
1. [Install @sap/cds-dk](https://cap.cloud.sap/docs/get-started/) globally as documented in [capire](https://cap.cloud.sap)
|
||||
1. Install [**@sap/cds-dk**](https://cap.cloud.sap/docs/get-started/) globally:
|
||||
|
||||
```sh
|
||||
npm i -g @sap/cds-dk
|
||||
```
|
||||
2. _Optional:_ [Use Visual Studio Code](https://cap.cloud.sap/docs/get-started/in-vscode)
|
||||
|
||||
2. _Optional:_ [Use Visual Studio Code](https://cap.cloud.sap/docs/get-started/tools#vscode)
|
||||
|
||||
### Download
|
||||
|
||||
Clone this repo as shown below, if you have [git](https://git-scm.com/downloads) installed,
|
||||
otherwise [download as zip file](archive/master.zip).
|
||||
If you have [Git](https://git-scm.com/downloads) installed, clone this repo as shown below, otherwise [download as ZIP file](archive/master.zip).
|
||||
|
||||
```sh
|
||||
git clone https://github.com/sap-samples/cloud-cap-samples samples
|
||||
@@ -47,6 +48,7 @@ When asked to log in, type `alice` as user and leave the password field blank, w
|
||||
### Testing
|
||||
|
||||
Run the provided tests with [_jest_](http://jestjs.io) or [_mocha_](http://mochajs.org), for example:
|
||||
|
||||
```sh
|
||||
npx jest
|
||||
```
|
||||
@@ -55,7 +57,7 @@ npx jest
|
||||
|
||||
### Serve `npm`
|
||||
|
||||
We've included a simple npm registry mock which allows you to do an `npm install @capire/<package>` locally. Use it as follows:
|
||||
We've included a simple npm registry mock, which allows you to do an `npm install @capire/<package>` locally. Use it as follows:
|
||||
|
||||
1. Start the @capire registry:
|
||||
```sh
|
||||
@@ -63,7 +65,8 @@ npm run registry
|
||||
```
|
||||
> While running this will have `@capire:registry=http://localhost:4444` set with npmrc.
|
||||
|
||||
2. Install one of the @capire packages wherever you like, e.g.:
|
||||
2. Install one of the @capire packages wherever you like, for example:
|
||||
|
||||
```sh
|
||||
npm add @capire/common @capire/bookshop
|
||||
```
|
||||
@@ -77,4 +80,4 @@ In case you have a question, find a bug, or otherwise need support, please use o
|
||||
|
||||
## License
|
||||
|
||||
Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSES/Apache-2.0.txt) file.
|
||||
Copyright (c) 2021 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSES/Apache-2.0.txt) file.
|
||||
|
||||
@@ -5,10 +5,10 @@ This stand-alone sample introduces the essential tasks in the development of CAP
|
||||
## Hypothetical Use Cases
|
||||
|
||||
1. Build a service that allows to browse _Books_ and _Authors_.
|
||||
2. Books have assigned _Genres_ which are organized hierarchically.
|
||||
2. Books have assigned _Genres_, which are organized hierarchically.
|
||||
3. All users may browse books without login.
|
||||
4. All entries are maintained by Administrators.
|
||||
5. End users may order books (the actual order mgmt being out of scope)
|
||||
5. End users may order books (the actual order mgmt being out of scope).
|
||||
|
||||
## Running the Sample
|
||||
|
||||
@@ -20,12 +20,12 @@ npm run watch
|
||||
|
||||
| Links to capire | Sample files / folders |
|
||||
| --------------------------------------------------------------------------------------------------------- | ------------------------------------ |
|
||||
| [Project Setup and Layouts](https://cap.cloud.sap/docs/get-started/projects#sharing-and-reusing-content) | [`./`](./) |
|
||||
| [Defining Domain Models](https://cap.cloud.sap/docs/guides/domain-models) | [`./db/schema.cds`](./db/schema.cds) |
|
||||
| [Defining Services](https://cap.cloud.sap/docs/guides/providing-services) | [`./srv/*.cds`](./srv) |
|
||||
| [Single-purposed Services](https://cap.cloud.sap/docs/guides/providing-services#single-purposed-services) | [`./srv/*.cds`](./srv) |
|
||||
| [Generic Providers](https://cap.cloud.sap/docs/guides/providing-services) | http://localhost:4004 |
|
||||
| Using Databases | [`./db/data/*.csv`](./db/data) |
|
||||
| [Project Setup & Layouts](https://cap.cloud.sap/docs/get-started/projects#sharing-and-reusing-content) | [`./`](./) |
|
||||
| [Domain Modeling with CDS](https://cap.cloud.sap/docs/guides/domain-models) | [`./db/schema.cds`](./db/schema.cds) |
|
||||
| [Defining Services](https://cap.cloud.sap/docs/guides/services#defining-services) | [`./srv/*.cds`](./srv) |
|
||||
| [Single-purposed Services](https://cap.cloud.sap/docs/guides/services#single-purposed-services) | [`./srv/*.cds`](./srv) |
|
||||
| [Providing & Consuming Providers](https://cap.cloud.sap/docs/guides/providing-services) | http://localhost:4004 |
|
||||
| [Using Databases](https://cap.cloud.sap/docs/guides/databases) | [`./db/data/*.csv`](./db/data) |
|
||||
| [Adding Custom Logic](https://cap.cloud.sap/docs/guides/service-impl) | [`./srv/*.js`](./srv) |
|
||||
| Adding Tests | [`./test`](./test) |
|
||||
| [Sharing for Reuse](https://cap.cloud.sap/docs/get-started/projects#sharing-and-reusing-content) | [`./index.cds`](./index.cds) |
|
||||
| Adding Tests | [`./test`](./test) |
|
||||
| [Sharing for Reuse](https://cap.cloud.sap/docs/guides/reuse-and-compose) | [`./index.cds`](./index.cds) |
|
||||
|
||||
20
samples.md
20
samples.md
@@ -1,7 +1,7 @@
|
||||
# Overview of Samples
|
||||
|
||||
The list below gives an overview of the samples provided in subdirectories.
|
||||
Each sub directory essentially is a individual npm package arranged in an [all-in-one monorepo](all-in-one-monorepo) umbrella setup.
|
||||
The following list gives an overview of the samples provided in subdirectories.
|
||||
Each sub directory essentially is an individual npm package arranged in an [all-in-one monorepo](all-in-one-monorepo) umbrella setup.
|
||||
|
||||
|
||||
## [@capire/hello-world](hello)
|
||||
@@ -13,7 +13,7 @@ Each sub directory essentially is a individual npm package arranged in an [all-i
|
||||
|
||||
- [Getting Started](https://cap.cloud.sap/docs/get-started/in-a-nutshell) with CAP, briefly introducing:
|
||||
- [Project Setup](https://cap.cloud.sap/docs/get-started/) and [Layouts](https://cap.cloud.sap/docs/get-started/projects)
|
||||
- [Domain Modelling](https://cap.cloud.sap/docs/guides/domain-models)
|
||||
- [Domain Modeling](https://cap.cloud.sap/docs/guides/domain-models)
|
||||
- [Defining Services](https://cap.cloud.sap/docs/guides/providing-services)
|
||||
- [Generic Providers](https://cap.cloud.sap/docs/guides/generic-providers)
|
||||
- [Adding Custom Logic](https://cap.cloud.sap/docs/guides/service-impl)
|
||||
@@ -22,7 +22,7 @@ Each sub directory essentially is a individual npm package arranged in an [all-i
|
||||
|
||||
## [@capire/common](common)
|
||||
|
||||
- Showcases how to extend [@sap/cds/common](https://cap.cloud.sap/docs/cds/common) thereby covering...
|
||||
- Showcases how to extend [@sap/cds/common](https://cap.cloud.sap/docs/cds/common) thereby covering:
|
||||
- Building [extension packages](https://cap.cloud.sap/docs/guides/domain-models#aspects-extensibility)
|
||||
- Providing [reuse packages](https://cap.cloud.sap/docs/get-started/projects#sharing-and-reusing-content)
|
||||
- [Verticalization](https://cap.cloud.sap/docs/cds/common#adapting-to-your-needs)
|
||||
@@ -32,22 +32,22 @@ Each sub directory essentially is a individual npm package arranged in an [all-i
|
||||
|
||||
## [@capire/orders](orders)
|
||||
|
||||
- A standalone orders mgmt service, demonstrating...
|
||||
- A standalone orders management service, demonstrating:
|
||||
- Using [Compositions](https://cap.cloud.sap/docs/cds/cdl#compositions) in [Domain Models](https://cap.cloud.sap/docs/guides/domain-models), along with
|
||||
- [Serving deeply nested documents](https://cap.cloud.sap/docs/guides/generic-providers#serving-structured-data)
|
||||
|
||||
|
||||
## [@capire/reviews](reviews)
|
||||
|
||||
- Shows how to implement a modular service to manage product reviews, including...
|
||||
- Shows how to implement a modular service to manage product reviews, including:
|
||||
- Consuming other services synchronously and asynchronously
|
||||
- Serving requests synchronously
|
||||
- Emitting events asynchronously
|
||||
- Grow as you go, with...
|
||||
- Grow as you go, with:
|
||||
- Mocking app services
|
||||
- Running service meshes
|
||||
- Late-cut Micro Services
|
||||
- As well as managed data, input validations and authorization
|
||||
- As well as managed data, input validations, and authorization
|
||||
|
||||
|
||||
## [@capire/fiori](fiori)
|
||||
@@ -57,11 +57,11 @@ Each sub directory essentially is a individual npm package arranged in an [all-i
|
||||
- [@capire/reviews](reviews)
|
||||
- [@capire/orders](orders)
|
||||
- [@capire/common](common)
|
||||
- [Adds a Fiori elements application](https://cap.cloud.sap/docs/guides/fiori/) to bookshop, thereby introducing to...
|
||||
- [Adds a SAP Fiori elements application](https://cap.cloud.sap/docs/guides/fiori/) to bookshop, thereby introducing to:
|
||||
- [OData Annotations](https://cap.cloud.sap/docs/guides/fiori#adding-odata-annotations) in `.cds` files
|
||||
- Support for [Fiori Draft](https://cap.cloud.sap/docs/guides/fiori#draft)
|
||||
- Support for [Value Helps](https://cap.cloud.sap/docs/guides/fiori#value-help)
|
||||
- Serving Fiori apps locally
|
||||
- Serving SAP Fiori apps locally
|
||||
- [The Vue.js app](bookshop/app/vue) imported from bookshop is served as well
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user