UNPKG

1.4 kBMarkdownView Raw
1# wch-components-bundle
2
3Container project to bundle [WCH](https://www.ibm.com/products/watson-content-hub) data records and UI components as an [npm](http://npmjs.com/) module. Such a module can then be used as a dependency by single page application projects to populate a tenant with data.
4
5## Changes
6
7[CHANGELOG](./CHANGELOG.md)
8
9## Usage
10
11This library is meant to be used in an [Angular](https://angular.io/) based application.
12
13### Use as a template
14
15Use this project as a template for custom bundles.
16
17* Set this as an upstream project, so you can easily consume changes: `git remote add upstream git@github.ibm.com:DX-Components/wch-components-bundle.git`
18* Pull changes from upstream `git pull upstream master`
19
20### Deploy the application and WCH artifacts
21
22The library bundles the [WCH](https://www.ibm.com/products/watson-content-hub) content types, layouts and layout mappings. Deploy these artifacts to WCH, e.g. by using the following command of the [CLI](https://www.npmjs.com/package/ibm-wch-sdk-cli):
23
24```bash
25ibm-wch-sdk-cli application push --data ./data/ --override --aggregated
26```
27
28The `--aggregated` flag makes sure to not only deploy the application data but also the bundled dependencies.
29
30**Note:** In order to successfully execute the command make sure to meet me prerequisites mentioned in the documentation of the [CLI](https://www.npmjs.com/package/ibm-wch-sdk-cli).