Skip to content

Latest commit

 

History

History
69 lines (59 loc) · 3.75 KB

README.md

File metadata and controls

69 lines (59 loc) · 3.75 KB
Raw

CircleCI Coverage Status Language grade: JavaScript Commitizen friendly GitHub license REUSE status dependentbot

Application Wizard

Description

With the Application Wizard extension, you can benefit from a rich user experience for yeoman generators. This extension allows developers to reuse existing yeoman generators and provide wizard-like experience with no development efforts. The repository contains three main packages:

  • Frontend - The Application Wizard as a standalone vue.js application.
  • Backend - The backend part which communicates with Yeoman and the system. Runs as a VSCode extension or node.js application.
  • Yeoman example generator - Example generator to show usages and test the platform.

Requirements

Download and Installation

To test run the framework you only need to build and install the backend package, which will automatically build and run the UI.

installation

  • Clone this repository
  • cd into the backend folder 
    cd backend
  • To install, compile and prepare the static resources run the following commands: 
    npm run backend
npm run frontend

Usage & Development

Run the dev mode

Dev mode allows you to run the framework in the browser, using vue cli for fast development cycles, and easy debug tools. To run it do the following:

  • In the backend folder run webpack or webpack-dev, then run the server. 
    npm run webpack-dev
npm run ws:run
  • In the frontend folder run serve 
    npm run serve
  • Open the broswer on localhost:8080 to access the framework.

Run the VSCode extension

  • Start VSCode on your local machine, and click on open workspace. Select this repo folder.
  • On the debug panel choose "Run Extension", and click on the "Run" button.

Enable usage analytics reporting from VS Code

The tool collects non-personally identifiable information about your usage of the tool to improve its services. If you do not want the tool to collect your usage data, you can set the "Enable Sap Web Analytics" setting to "false". Go to File > Preferences > Settings (macOS: Code > Preferences > Settings) > Extensions > Application Wizard, and deselect the "Enable Sap Web Analytics" checkbox.

Advanced scenarios

To develop and contribute you can build and install each package separately. Instruction on each package in the dedicated readme.md file.

How to obtain support

To get more help, support, and information please open a github issue.

Contributing

Contributing information can be found in the CONTRIBUTING.md file.