npm:generator-tymlez-plugin

README

yeoman generator

Installation

First, install Yeoman ( a code generation tool)::

npm i -g yo

Next, you can install the Tymlez Plugin App Generator::

npm install -g generator-tymlez-plugin

Usage

Next, create a directory for the application and enter into that directory::

mkdir hello-tymlez && cd hello-tymlez

Create distribution package

go to the Target Folder where the plugin code got generated and into the plugin folder

npm i

Generate the distribution package. This will generate a zip file in folder ./dist with the same name as the plugin name

npx tymlez-dev gulp dist

Upload the Plugin

Signin as admin of your instance and install / activate the plugin via the Plugin Manager

Running the generated plugin app locally

unzip the distribution zip file into the plugin folder of your instance. i.e. ./plugins/customFolder

and install / activate the plugin via the Plugin Manager

Recommended developer workflow

Make changes directly in your generated plugin repository/folder.
When you want to upload these new changes, run the following two commands to generate the distribution file and upload it to the server. Note: If you are uploading to your server for the first time, you need an app key in your plugin settings, explained below.

    $   npx tymlez-dev gulp dist
    $   npx tymlez-dev plugin upload

For even quicker upload for your changes, add this alias to your bash profile.

    $   alias up=npx tymlez-dev gulp dist; npx tymlez-dev plugin upload

Adding an app key

In the UI, log in as admin and navigate to the top right corner and click App keys.
Click Add key to create a key. Select ng-rt-admin and domain A.
After creating the key, copy and paste the app key for ng-rt-admin into the config.json of your home/.tymlez folder in the following format:

},
"env": {
    "default": "local",
    "local": {
      "serverType": "http",
      "serverUrl": "<Server URL>",
      "bigchaindbUrl": "127.0.0.1:59984",
      "keypair": {
          "public": "<YOUR_PUBLIC_KEY_HERE"
          "private": "<YOUR_PRIVATE_KEY_HERE>"
      },
      "storage": "main",
      "appKeys": [
          {
          "appName": "ng-rt-admin",
          "key": "<PLACE YOUR APP KEY HERE>"
          }
        ],

Usage no npm install needed!