0.4.8 • Published 6 years ago

generator-ui5-boilerplate v0.4.8

Weekly downloads
11
License
MIT
Repository
github
Last release
6 years ago

UI5 Boilerplate Generator NPM version Build Status Dependency Status

Note: 🚧 This generator is under heavy development. Use at your own risk! 🚧

This generator is meant for use with Yeoman

Contributions are very welcome! āœŒļø

Installation

First, install Yeoman, generator-ui5-boilerplate and UI5 CLI using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-ui5-boilerplate
npm install -g @ui5/cli

Navigate to your workspace directory and then generate your new project. The generator will ask you a bunch of questions to build a comprehensive boilerplate project for you.

cd ~/workspace
yo ui5-boilerplate

After everything is set up navigate into the newly created project directory. You'll find a quick start guide in the project README.md file.

TODO

  • Add unit and integration tests for Simple App template
  • Add Master/Detail app template
  • Add Flexible Column Layout app template
  • Add Library template
  • Add sub generators for views/controllers
  • Add sub generator for control
  • Add option to read metadata file from provided OData-Service
    • and output entities etc.
    • save metadata.xml file for mockserver use
  • Add further tests for right file content
  • Add select questions for documentation purposes (All SAP Roles, ...)
  • Split app templates in base files and layout specific changes/additions (kill redundancy)


Here is a sample output of tree command for a generated simple-app project.

project-folder
ā”œā”€ā”€ webapp
│   ā”œā”€ā”€ controller
│   │   ā”œā”€ā”€ App.controller.js
│   │   └── BaseController.js
│   ā”œā”€ā”€ css
│   │   └── style.css
│   ā”œā”€ā”€ i18n
│   │   └── i18n.properties
│   ā”œā”€ā”€ localService
│   │   ā”œā”€ā”€ mockdata
│   │   │   ā”œā”€ā”€ CarrierCollection.json
│   │   │   └── FlightCollection.json
│   │   ā”œā”€ā”€ metadata.xml
│   │   └── mockserver.js
│   ā”œā”€ā”€ model
│   │   ā”œā”€ā”€ formatter.js
│   │   └── models.js
│   ā”œā”€ā”€ test
│   │   ā”œā”€ā”€ integration
│   │   │   ā”œā”€ā”€ pages
│   │   │   │   ā”œā”€ā”€ App.js
│   │   │   │   └── Common.js
│   │   │   ā”œā”€ā”€ AllJourneys.js
│   │   │   ā”œā”€ā”€ AppJourney.js
│   │   │   └── opaTests.qunit.html
│   │   ā”œā”€ā”€ unit
│   │   │   ā”œā”€ā”€ controller
│   │   │   │   └── BaseController.js
│   │   │   ā”œā”€ā”€ allTests.js
│   │   │   └── unitTests.qunit.html
│   │   └── testsuite.qunit.html
│   ā”œā”€ā”€ view
│   │   ā”œā”€ā”€ dialogs
│   │   │   └── .gitkeep
│   │   ā”œā”€ā”€ fragments
│   │   │   └── .gitkeep
│   │   └── App.view.xml
│   ā”œā”€ā”€ Component.js
│   ā”œā”€ā”€ flpSandbox.html
│   ā”œā”€ā”€ flpSandboxMockServer.html
│   ā”œā”€ā”€ index.html
│   └── manifest.json
ā”œā”€ā”€ .editorconfig
ā”œā”€ā”€ .eslintignore
ā”œā”€ā”€ .eslintrc
ā”œā”€ā”€ .gitignore
ā”œā”€ā”€ .npmrc
ā”œā”€ā”€ .travis.yml
ā”œā”€ā”€ LICENSE
ā”œā”€ā”€ README.md
ā”œā”€ā”€ karma-ci.conf.js
ā”œā”€ā”€ karma.conf.js
ā”œā”€ā”€ neo-app.json
ā”œā”€ā”€ package-lock.json
ā”œā”€ā”€ package.json
└── ui5.yaml

15 directories, 41 files

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

License

MIT Ā© Nils Lutz

GIFs

Because we all love GIFs šŸ––

Prerequisites

npm install -g @ui5/cli yo generator-ui5-boilerplate

Generator in use

yo ui5-boilerplate

Test the result

npm test

0.4.8

6 years ago

0.4.7

6 years ago

0.4.3

7 years ago

0.4.2

7 years ago

0.4.1

7 years ago

0.4.0

7 years ago

0.3.5

7 years ago

0.3.4

7 years ago

0.3.3

7 years ago

0.3.2

7 years ago

0.3.1

7 years ago

0.3.0

7 years ago

0.2.0

7 years ago

0.1.0

7 years ago