This project is meant to simplify the initial configuration needed to create and deploy an end-to-end application to a Cloud Foundry account in SAP Cloud Platform.
What cf-create-app does for you?
cf-create-app uses the following technologies and frameworks:
Setting and end-to-end application in SAP Cloud Platform is not a trivial task.
This tool creates a project with all the components you need to build (and easily deploy) a web application with a CAP backend exposing OData services, and an HTML5 application ready to consume those services.
Pre-requisite | Description | Documentation |
---|---|---|
Node.js v12 | Required runtime for this boilerplate. Recommended install it with NVM | Download |
cf cli | Cloud Foundy CLI tool | Download |
To be able to deploy this application you need an SAP Cloud Platform account in the Cloud Foundry (CF) environment.
In your CF account space, the following services must be available:
html5-apps-repo
hana
xsuaa
Tools | Description | Documentation |
---|---|---|
VS Code CDS extension | VS Code extension with code complete and other tools for CDS development | Download |
MTA Plugin for CF CLI | Plugin to add useful commands to manage MTA applications using CF CLI | Download |
HTML5 Applications Repository CF CLI Plugin | Plugin to add useful commands to manage HTML5 Application Repository apps using CF CLI | Download |
Open a terminal in your workspace directory and run:
npx cf-create-app YOUR_APP_NAME
In the comand prompt, choose the frontend framework you prefer:
In the comand prompt, choose the frontend framework you prefer:
The new project contains these folders and files, following the recommended project layout:
File / Folder | Purpose |
---|---|
app/ |
content for UI frontends go here |
approuter/ |
Application Router configuration files |
db/ |
your domain models and data go here |
html5Deployer/ |
helper application to deploy HTML5 apps to the HTML5 Application Repository service in SAP Cloud Platform |
srv/ |
your service models and code go here |
package.json |
project metadata and configuration |
README.md |
this getting started guide |
db/
foldersrv/
folderapp/
folderapprouter/xs-app.json
Open a terminal in the project root directory and run:
mbt build
cf deploy mta_archives/yourAppMtarArchiveName.mtar
Learn more about localhost development on: Localhost Development
Learn more about manual configuration on: Manual Configuration
These are some of our backlog items
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
git checkout -b feature/AmazingFeature
)git commit -m 'Add some AmazingFeature'
)git push origin feature/AmazingFeature
)Distributed under the MIT License.
Project Link: https://github.com/Turutupa/cf-create-app