SAP-samples/cap-local-development-workshop

CAP local development workshop

Description

The content of this repository is for use in a reCAP 2025 hands-on workshop:

Title: Stay cool, stay local.

Abstract: CAP has myriad features to help developers develop. And that means local first, in a tight feedback loop. In this session you'll learn about those features and tools at your disposal as a CAP developer (predominantly Node.js) and get the chance to try some of them out yourself.

Prerequisites

To participate in this workshop, the following prerequisites are required:

Ideally:

• The following installed on your laptop:
  • VS Code
  • Docker Desktop (or equivalent container runtime engine)
  • the Dev Containers extension installed in VS Code
  • git (to be able to clone a repository from GitHub)

Alternatively:

Your own development environment for CAP Node.js already set up and working, with CAP Node.js 9.0.0+ installed and a Bash-compatible shell (e.g. via WSL on Windows), plus jq and curl installed.

In both cases:

• An active trial account on SAP Business Technology Platform, with a Cloud Foundry environment instance (see this tutorial for details) - this will be needed for the last exercise, and we may be able to supply temporary access for participants

Exercises

Work through each of the following exercises one at a time, each of which cover one or more topics that are relevant for local development (and are shown in brackets following the exercise titles). When reading through the exercises, actions for you to take, things you have to do yourself, are indicated with the 👉 symbol.

• 00 - setting up and getting to a running server (cds watch)
• 01 - cds watch, SQLite, initial data and sample data (cds watch, SQLite, initial data)
• 02 - configuration profiles, more on initial data, and the cds REPL (configuration profiles, initial data, cds REPL)
• 03 - mocking auth and required services (mock user authentication, mocking of required services)
• 04 - a first look at local messaging and events (local messaging, file-based messaging)
• 05 - workspaces, monorepos and more on messaging and events (workspaces and monorepos, plugins, file-based messaging)
• 06 - debugging local and remote servers (debugging remote applications)

Other topics

There are other topics in Capire that also are relevant for local development, but not covered in this workshop (except in passing):

• hybrid testing
• linting
• cds init
• cds add
• serving UIs

How to obtain support

Support for the content in this repository is available during the actual time of the workshop event for which this content has been designed.

License

Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.