This is your SAP Cloud Platform Cloud Foundry application powered by the SAP Cloud SDK for JavaScript and NestJS.

Everything is ready to go.

# Run the application locally
$ npm run start:dev

# Open the application in your default browser
$ open http://localhost:3000/

If you have the Cloud Foundry CLI and are logged in, you can deploy the application without any changes to the application.

# Deploy your application to SAP Cloud Platform Cloud Foundry
$ cf push

The project comes with unit and end-to-end tests. Unit tests are located in the src/ folder next to the modules and controllers, while end-to-end tests are in the test/ folder.

# Run unit tests
$ npm run test

# Run e2e tests
$ npm run test:e2e

This project is preconfigured to run with the SAP Cloud SDK Pipeline. To get the installer follow the short guide.

# If you have the SAP Cloud SDK CLI installed, it can download the install script for you
sap-cloud-sdk add-cx-server

# Execute the script to start the Jenkins server
$ ./cx-server start

Point the new Jenkins to your repository and it will automatically run the pipeline. If the pipeline should deploy your application as well, you need to modify the .pipeline/config.yml.

NestJS is a progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.

The Nest CLI is a powerful tool and can help you create new controllers, modules and interfaces.

If you need support with the SAP Cloud SDK, the SAP Cloud SDK CLI or this project scaffold, feel free to open an issue on GitHub or ask a question on stackoverflow with tag [sap-cloud-sdk].

The SAP Cloud SDK CLI is licensed under the Apache Software License, v. 2. Nest is MIT licensed.

The SAP Cloud SDK is in no way affiliated with or endorsed by Nest and its maintainers. While Nest is our recommendation, the SAP Cloud SDK can be used with any framework, so you are free to choose what you are comfortable with.