Neverending Pile of Messages

    generator-easy-ui5

    1.0.2 • Public • Published

    Easy UI5 Generator

    NPM version Build Status Dependency Status License Status

    Description

    Easy-ui5 is a Yeoman generator which enables you to create simple OpenUI5-based web-apps within seconds.

    This generator has been created to simplify the creation of your OpenUI5 prototypes. Now you can scaffold simple UI5 projects from the shell/terminal of your choice. The current best practices (such as async) are already baked into our templates so you don't have to worry about the definition of the metadata files.

    The purpose of this generator is to guide you on your first steps with SAPUI5 and SAP Cloud Platform deployments. Once you are familiar with those technologies, you might want to tweak the projects to adapt them for productive use-cases (such as continuous deployment pipelines and full i18n).

    Installation

    1. Get Node.js (version 8.5 or higher)
    2. Install the generator
      npm install -g yo generator-easy-ui5
    3. Verify your installation to see if Yeoman has been installed correctly
      yo
      Make sure you see the easy-ui5 generator listed.

    Usage

    Create your first OpenUI5 App within a few seconds!

    1. Scaffold your OpenUI5 project
      yo easy-ui5
      
    2. Answer the prompts to create your OpenUI5 project
    3. Run it locally
      cd <your project name>
      npm start
      

    Add a new view

    This sub-generator will create a new view (of the same type you specified during the creating of your project) and a new controller.

    yo easy-ui5:newview
    

    Create a custom control

    Run the following command from your project's root to scaffold a custom control.

    yo easy-ui5:newcontrol
    

    Deployment

    Depending on your target platform you'll need to install additional tools:

    Cloud Foundry Embedded in Application Router

    Required tools

    1. Create a free SAP Cloud Platform Cloud account
    2. Install the Cloud Foundry Command Line Interface
      cf login
    3. Install the MultiApps CF CLI Plugin

    Deploy

    Call this command from the root directory to deploy the application to Cloud Foundry

    npm run deploy
    

    Cloud Foundry within the HTML5 Application Repository

    Required tools

    1. Create a free SAP Cloud Platform Cloud account
    2. Install the Cloud Foundry Command Line Interface
      cf login
    3. Install the MultiApps CF CLI Plugin cf install-plugin -r CF-Community "multiapps"
    4. Install the HTML5 Applications Repository CF CLI Plugin cf install-plugin -r CF-Community "html5-plugin"

    Deploy

    Call this command from the root directory to deploy the application to Cloud Foundry

    npm run deploy
    

    HANA XSA

    Required tools

    1. SAP HANA or create a free SAP HANA Express system
    2. Install the XS CLI Client
      xs login

    Deploy

    Call this command from the root directory to deploy the application to HANA XSA

    npm run deploy
    

    Embedded Technologies

    This project leverages (among others) the following Open Source projects:

    Support

    Please use the GitHub bug tracking system to post questions, bug reports or to create pull requests.

    Contributing

    We welcome any type of contribution (code contributions, pull requests, issues) to this easy-ui5 generator equally.

    Please follow our instructions if you would like to contribute.

    To-Do

    The following aspects/features are not yet implemented:

    • Add more target platforms:
      • SAP Cloud Platform Neo environment
      • SAP NetWeaver

    Contributions are very much appreciated.

    License

    Copyright (c) 2019 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.

    Install

    npm i generator-easy-ui5@1.0.2

    Version

    1.0.2

    License

    Apache-2.0

    Unpacked Size

    56.2 kB

    Total Files

    41

    Last publish

    Collaborators

    • pmuessig
    • iobert
    • ui5-community-bot
    • nicogeburek