UNPKG

2.4 kBMarkdownView Raw
1# Launch Extension Packager
2
3[![npm (scoped)](https://img.shields.io/npm/v/@adobe/reactor-packager.svg?style=flat)](https://www.npmjs.com/package/@adobe/reactor-packager)
4
5Launch, by Adobe, is a next-generation tag management solution enabling simplified deployment of marketing technologies. For more information regarding Launch, please visit our [product website](http://www.adobe.com/enterprise/cloud-platform/launch.html).
6
7The extension packager is a command-line utility for packaging a Launch extension into a zip file suitable to be uploaded to Launch. While using this utility is not necessary, it will validate that your extension appears well-structured (e.g., files that are referenced exist in the directory) and make an effort to exclude anything from the zip file not necessary for the extension to operate.
8
9For more information about developing an extension for Launch, please visit our [extension development guide](https://developer.adobelaunch.com/guides/extensions/).
10
11## Usage
12
13Before running the packager, you must first have [Node.js](https://nodejs.org/en/) installed on your computer. Your npm version (npm comes bundled with Node.js) will need to be at least 5.2.0. You can check the installed version by running the following command from a command line:
14
15```
16npm -v
17```
18
19Once Node.js is installed, run the packager by executing the following command from the command line within your project's directory:
20
21```
22npx @adobe/reactor-packager
23```
24
25## Contributing
26
27Contributions are welcomed! Read the [Contributing Guide](CONTRIBUTING.md) for more information.
28
29To get started:
30
311. Install [node.js](https://nodejs.org/).
323. Clone the repository.
334. After navigating into the project directory, install project dependencies by running `npm install`.
34
35To manually test your changes, first run the following command from the packager tool directory:
36
37```
38npm link
39```
40
41Then, in a directory containing an extension (any extension you would like to use for testing), run the following command:
42
43```
44npx @adobe/reactor-packager
45```
46
47Npx will execute the packager tool using your locally linked code rather than the code published on the public npm repository.
48
49## Licensing
50
51This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.