https://github.com/sap/yeoman-ui

Provide rich user experience for Yeoman generators using VSCode extension or the browser.
https://github.com/sap/yeoman-ui

open-source

Last synced: about 1 year ago
JSON representation

Provide rich user experience for Yeoman generators using VSCode extension or the browser.

• Host: GitHub
• URL: https://github.com/sap/yeoman-ui
• Owner: SAP
• License: apache-2.0
• Created: 2019-11-06T16:30:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-04-01T11:29:19.000Z (about 1 year ago)
• Last Synced: 2025-04-07T09:08:32.917Z (about 1 year ago)
• Topics: open-source
• Language: TypeScript
• Size: 6.09 MB
• Stars: 104
• Watchers: 10
• Forks: 48
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![Continuous Integration](https://github.com/SAP/yeoman-ui/actions/workflows/ci.yml/badge.svg)](https://github.com/SAP/yeoman-ui/actions/workflows/ci.yml)

[![Coverage Status](https://coveralls.io/repos/github/SAP/yeoman-ui/badge.svg?branch=master)](https://coveralls.io/github/SAP/yeoman-ui?branch=master)

[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/SAP/yeoman-ui.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/SAP/yeoman-ui/context:javascript)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

![GitHub license](https://img.shields.io/badge/license-Apache_2.0-blue.svg)

[![REUSE status](https://api.reuse.software/badge/github.com/SAP/yeoman-ui)](https://api.reuse.software/info/github.com/SAP/yeoman-ui)

# Application Wizard

![](screenshot.png)

## 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.

This npm [mono-repo][mono-repo] currently contains:

- [VSCode Extension](./packages/backend) The backend part which communicates with Yeoman and the system. It runs as a VSCode extension or node.js application.

- [Application Wizard UI](./packages/frontend) The Application Wizard as a standalone vue.js application.

- [Yeoman generator sample](./packages/generator-foodq) Sample yeoman generator to show usages and test the platform.

- [![npm-yeoman-ui-types][npm-yeoman-ui-types-image]][npm-yeoman-ui-types-url] [@sap-devx/yeoman-ui-types](./packages/types) Type signatures supposed to be used in the yeoman generators.

[npm-yeoman-ui-types-image]: https://img.shields.io/npm/v/@sap-devx/yeoman-ui-types.svg

[npm-yeoman-ui-types-url]: https://www.npmjs.com/package/@sap-devx/yeoman-ui-types

## Support

To get more help, support, and information please open a github [issue](https://github.com/SAP/yeoman-ui/issues).

## Report an Issue

To report an issue please use the github issue tracker. Please try to make sure you have these in your issue:

- No duplicate

- Reproducible

- Good summary

- Well-documented

- Minimal example

## Issue handling process

When an issue is reported, a committer will look at it and either confirm it as a real issue (by giving the "in progress" label), close it if it is not an issue, or ask for more details. In-progress issues are then either assigned to a committer in GitHub, reported in our internal issue handling system, or left open as "contribution welcome" for easy or not urgent fixes.

An issue that is about a real bug is closed as soon as the fix is committed.

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md).

[mono-repo]: https://github.com/babel/babel/blob/master/doc/design/monorepo.md