1 | # Adobe I/O App Generator
|
2 |
|
3 | A Yeoman generator for Adobe I/O Applications.
|
4 |
|
5 | [![Version](https://img.shields.io/npm/v/@adobe/generator-aio-app.svg)](https://npmjs.org/package/@adobe/generator-aio-app)
|
6 | [![Downloads/week](https://img.shields.io/npm/dw/@adobe/generator-aio-app.svg)](https://npmjs.org/package/@adobe/generator-aio-app)
|
7 | [![Build Status](https://travis-ci.com/adobe/generator-aio-app.svg)](https://travis-ci.com/adobe/generator-aio-app)
|
8 | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
|
9 | [![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/generator-aio-app/master.svg?style=flat-square)](https://codecov.io/gh/adobe/generator-aio-app/)
|
10 |
|
11 |
|
12 | ## Usage
|
13 |
|
14 | This module is used by the Adobe I/O CLI app plugin.
|
15 |
|
16 | - `npm install -g @adobe/aio-cli`
|
17 |
|
18 | - `aio app init` to bootstrap your project's code
|
19 | - `aio app add action` to add new actions to an existing app
|
20 | - `aio app add web-assets` to add a UI to an existing app
|
21 | - `aio app add ci` to add a CI to an existing app
|
22 | - `aio app delete action` to delete an existing action
|
23 | - `aio app delete web-assets` to delete the app's UI
|
24 | - `aio app delete ci` to delete CI from existing app
|
25 |
|
26 | ## Contributing
|
27 |
|
28 | Contributions are welcomed! Read the [Contributing Guide](./.github/CONTRIBUTING.md) for more information.
|
29 |
|
30 | ### How to provide new template generators
|
31 |
|
32 | Two types of generators can be easily contributed to the project:
|
33 |
|
34 | - action generators, e.g. [analytics action generator](./generators/add-action/analytics/index.js):
|
35 |
|
36 | - add a new action template generator into `generators/add-action/<generator-name>/index.js`. It is recommended that
|
37 | the generator extends `lib/ActionGenerator.js` that provides a set of helpers.
|
38 | - add template files into `generators/add-action/<generator-name>/templates/`
|
39 | - update `generators/add-action/index.js` to reference the newly added generator in the prompt choices.
|
40 |
|
41 | - web assets generators, e.g. [experience cloud shell react generator](./generators/add-web-assets/exc-react/index.js):
|
42 |
|
43 | - add a new web assets template generator into `generators/add-web-assets/<generator-name>/index.js`.
|
44 | - add template files into `generators/add-web-assets/<generator-name>/templates/`
|
45 | - update `generators/add-web-assets/index.js` to reference the newly added generator in the prompt choices.
|
46 |
|
47 | ## Licensing
|
48 |
|
49 | This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.
|