1.0.4 โข Published 1 year ago
@ragarwal06/create-sap-fs-app v1.0.4
CLI Tool for SAP BTP Full-Stack Applications
A zero-config CLI tool to scaffold full-stack SAP Business Technology Platform (BTP) applications in minutes. Supports UI5 or React frontends and Node.js or Spring Boot backends, with ready-to-use deployment descriptors.
๐ Features
- Generates complete project boilerplates:
- UI5 or React frontend
- Node.js or Spring Boot backend
- Auto-configured
package.json/pom.xml, VS Code launch & task files - Predefined deployment descriptors:
mta.yaml,xs-app.json, etc. - Extensible via a plugin API or direct CLI flags
- Out-of-the-box integration with common SAP BTP services
- Consistent conventions for faster team onboarding
๐ฏ Prerequisites
- Node.js โฅ 14.19
- npm, yarn, or pnpm
- (Optional) SAP BTP CLI (
@sap/cli) & Cloud Foundry CLI (cf) to deploy
โ๏ธ Installation & Usage
Invoke the generator using your preferred package managerโs create command. This downloads and runs the latest CLI without global install.
npm
npm create @ragarwal06/sap-fs-app@latestyarn
yarn create @ragarwal06/sap-fs-app@latestpnpm
pnpm create @ragarwal06/sap-fs-app@latest๐ Usage
After running the create command, follow the interactive prompts:
- Project name, namespace, and package type
- Frontend choice: UI5 or React
- Backend choice: Node.js or Spring Boot
- Select additional SAP BTP services (e.g., Connectivity, XSUAA, HANA)
- Review dependency versions and confirm
The generator creates a new directory containing:
package.jsonorpom.xml- Scaffolded UI5/React frontend code
- Scaffolded Node.js/Spring Boot backend code
- Deployment descriptors (
mta.yaml,xs-app.json, etc.)
๐ License
This project is licensed under the ISC License. See the LICENSE file for details.