@adobe/generator-aio-app

Adobe I/O application yeoman code generator

Usage no npm install needed!

<script type="module">
  import adobeGeneratorAioApp from 'https://cdn.skypack.dev/@adobe/generator-aio-app';
</script>

README

Adobe I/O App Generator

A Yeoman generator for Adobe I/O Applications.

Version Downloads/week Node.js CI License Codecov Coverage

Usage

This module is used by the Adobe I/O CLI app plugin.

  • npm install -g @adobe/aio-cli

  • aio app init to bootstrap your project's code

  • aio app add action to add new actions to an existing app

  • aio app add web-assets to add a UI to an existing app

  • aio app add ci to add a CI to an existing app

  • aio app delete action to delete an existing action

  • aio app delete web-assets to delete the app's UI

  • aio app delete ci to delete CI from existing app

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

How to provide new template generators

Two types of generators can be easily contributed to the project:

  • action generators, e.g. analytics action generator:

    • add a new action template generator into generators/add-action/<generator-name>/index.js. It is recommended that the generator extends lib/ActionGenerator.js that provides a set of helpers.
    • add template files into generators/add-action/<generator-name>/templates/
    • update generators/add-action/index.js to reference the newly added generator in the prompt choices.
  • web assets generators, e.g. experience cloud shell react generator:

    • add a new web assets template generator into generators/add-web-assets/<generator-name>/index.js.
    • add template files into generators/add-web-assets/<generator-name>/templates/
    • update generators/add-web-assets/index.js to reference the newly added generator in the prompt choices.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.