Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/deislabs/duffle-bag

GUI tooling for CNAB bundles
https://github.com/deislabs/duffle-bag

Last synced: 4 months ago
JSON representation

GUI tooling for CNAB bundles

Awesome Lists containing this project

README 

        
# duffle-bag



A template for graphical user interfaces for working with CNAB bundles.



To run, `npm install` then `npm run dev`.



To package this as a standalone application, run `npm run package`.  If you want

to include Duffle binaries (so that the user doesn't need to have Duffle on their

system path), copy these into the relevant `dufflebin` directory before packaging.

(The duffle-coat extension for VS Code does this automatically, though you may

still want to do it manually if you need to upgrade the embedded Duffle binaries.)



# Creating an installer



The easiest way to create an installer from this template is to use the [duffle-coat](https://marketplace.visualstudio.com/items?itemName=ms-kubernetes-tools.duffle-coat)

extension for VS Code.  Right-click a bundle and choose `Generate Self-Installer`.



To hand author an installer, copy the templatem and copy your bundle (`bundle.json`,

`bundle.cnab` if signed, or `bundle.tgz` if a full exported bundle) into the `data`

directory.



**NOTE:** if embedding a full bundle, it *must* be named `bundle.tgz`.

By default, the Duffle CLI will name the `.tgz` file for the bundle name, but the

self-installer requires `bundle.tgz`.  Again, the duffle-coat extension handles this

automatically.



# Customizing the installer



The application generates most information dynamically from the included bundle

file (at `data/bundle.json`/`.cnab`/`.tgz`). The duffle-coat extension writes your bundle data

to this file at code generation time.  You can modify some chrome (e.g. product

name, window title, etc.) via `package.json`, `app/package.json` and `app/app.html`.

Again the duffle-coat extension sets reasonable defaults where it can.



You can provide additional information to users via the following extension points,

without needing to edit the source code:



* **Front page text:** You can display text on the first page of the application

  by creating a file `data/description.html`.  If `data/description.html` exists then

  it takes precedence over any `description` field in the bundle.

* **Installation result page text:** You can display text after the installation

  has completed by creating `data/postinstall.succeeded.html` and/or

  `data/postinstall.failed.html`.  These will be shown in addition to the

  Duffle result or error, in the event of success or failure respectively.

  If you want only want a post-install message in one case (e.g. only success),

  you only need to provide that HTML file - you don't need to provide both.



HTML documents should contain one or more HTML elements, which the program will

insert into a `div`.  You do not need to provide a parent element yourself, and should

not include page-level tags such as `` or ``.



## Example of a front page text document



`data/description.html`



```html

Welcome to the helloworld bundle.


Before installing this bundle, please have a nice cup of tea.


```



# Contributing



This project welcomes contributions and suggestions.  Most contributions require you to agree to a

Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us

the rights to use your contribution. For details, visit https://cla.microsoft.com.



When you submit a pull request, a CLA-bot will automatically determine whether you need to provide

a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions

provided by the bot. You will only need to do this once across all repos using our CLA.



This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or

contact [[email protected]](mailto:[email protected]) with any additional questions or comments.



# Acknowledgements



Based on [Alexander Rath's `electron-react-typescript-boilerplate` template](https://github.com/iRath96/electron-react-typescript-boilerplate).