golem-sdk v2.0.70

golem-sdk 2.0.70

golem-sdk is a SDK for golem-cli to build native desktop apps for Linux (Mac, Windows).

• golem-cli GOLEM app manager for Terminal.
• golem-sdk SDK to build linux desktop apps.
• golem-mock-server testing and simulate app server.
• golem-apps temporary hosted GOLEM app library.
• golem-store graphical web interface for app library.

prerequisites

we need NodeJS runtime,

$ curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
$ sudo apt install -y nodejs
$ sudo npm i -g n
$ sudo n stable

upgrade

NOTE: if you upgraded to latest golem-sdk version, you have upgrade all installed apps,

$ golem upgrade-all

flash Plugin

$ sudo apt install -y pepperflashplugin-nonfree browser-plugin-freshplayer-pepperflash

to configure the GOLEM app to use flash plugin, edit your created app file located in /<app_name>/resources/app/golem.json

Use text editor to replace or add the following line,

"flashPluginDir": "/usr/lib/pepperflashplugin-nonfree/libpepflashplayer.so",

usage

clone the repository,

$ git clone https://github.com/loouislow81/golem-sdk.git

set things up,

$ cd golem-sdk
$ npm i
$ npm run build

example of usage,

$ cd golem-sdk
$ node lib/cli.js --name duckduckgo --icon icon.png --platform linux --arch x64 --show-menu-bar --disk-cache-size 500000000 "https://duckduckgo.com"

to configure and run globally,

$ npm link

then you can use,

$ golem-sdk --name duckduckgo --icon icon.png --platform linux --arch x64 --show-menu-bar --disk-cache-size 500000000 "https://duckduckgo.com"

Note: App that created with Golem, the app settings file is located in /<app_name>/resources/app/golem.json. You can change any parameters in this golem.json file. Read below API and learn how to configure your app behaviour.

troubleshoot

if you run into trouble running golem-cli, try configure prefix for node_modules,

$ sudo npm config set prefix /usr/local/lib

cli

to run SDK in Terminal,

$ node lib/cli.js -h

golem-sdk [options] <targetURL> [dest]

command line options are listed below,

api

_commands

programmatic api + golem-craft tool

You can use the GOLEM SDK programmatic API together with the dedicated golem-craft.sh script to built multiple apps at once.

_crafter

download golem-apps,

$ git clone https://github.com/loouislow81/golem-apps
$ cd golem-apps
$ npm i

cli

_structure

.
├── applist.json (for mock)
├── apps (package here is a tar.gz format moved from staging folder)
├── golem-craft.sh
├── inject.css (put your CSS code here)
├── inject.js (put your JS code here)
├── library.json (for mock)
├── list.conf (custom list to build only selected apps)
├── node_modules (put `golem-sdk` here!)
├── notifications.json (for mock)
├── __restricted (ignore)
├── __staging (staging area after app was built)
└── tasks

copy golem-sdk folder into golem-apps root folder e.g. /golem-apps/node_modules/, you will need to manually create new folder named node_modules before copy golem-sdk into it.

alright, you have set up a dependency for golem-apps to work with golem-sdk, let's craft new app in no time that came with the task files in tasks/ folder.

$ ./golem-craft --craft-select <appname>

Note: The availability of is depend on the content in tasks/ folder. Where you can preset your app programmatically.

_task

to make your app building programmatically, you need to create task file for each app, the js task file and png app icon file name should be the same.

example to create new task file <appname>.js,

const golem = require('golem-sdk').default

homePath = '../'
taskPath = 'tasks/'
staging = homePath + '__staging'
category = 'adobe/'
appName = 'adobe-color-cc'
appDesc = 'Capture colour combinations whenever inspiration strikes with Adobe Color CC and your iPhone, iPad or Android device. Your colour themes are automatically saved to Creative Cloud Libraries for access in desktop and mobile apps or to share with your team.'

options = {
  name: appName,
  targetUrl: 'https://color.adobe.com/create/color-wheel',
  icon: category + appName + '.png',
  platform: 'linux',
  arch: 'x64',
  version: '1.0.1',
  userAgent: 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.102 Safari/537.36',
  asar: true,
  width: 1280,
  height: 800,
  overwrite: false,
  counter: false,
  bounce: false,
  showMenuBar: false,
  fastQuit: false,
  ignoreCertificate: false,
  ignoreGpuBlacklist: false,
  enableEs3Apis: false,
  insecure: false,
  //flashPluginDir: '/usr/lib/pepperflashplugin-nonfree/libpepflashplayer.so',
  internalUrls: null,
  diskCacheSize: '200000000',
  honest: false,
  fullScreen: false,
  maximize: false,
  zoom: 1.0,
  singleInstance: false,
  fileDownloadOptions: {
    saveAs: true
  },
  win32metadata: {
    ProductName: appName,
    InternalName: appName,
    FileDescription: appDesc
  },
  out: staging
}

golem(options, (error, appPath) => {
  if (error) {
    console.error(error)
    return
  }
  console.log(appName + ' app has moved to to >>', appPath)
})

_upgrade

(!!) Whenever you upgraded to latest golem-sdk, you should upgrade all installed apps with,

$ golem upgrade-all