Hadouken Core

Requirements

The following setup is known to be working well. You can try other versions at your own risk of losing a lot of time.

• Visual Studio 2015 Build Tools *
• Node 6.9.0
• Grunt (grunt-cli 1.2.0)
• Python 2.7.12
• Optional: node-inspector 0.12.3 (problems with 0.12.4 - 0.12.8)

_______________

* Only needed on Windows

Building the project

Mac/Linux

npm install

Windows

You need to ensure that Visual Studio 2013 is used to build the project.

npm update -msvs_version=2015
npm install

Testing

• Install the OpenFin cli tool

npm install -g openfin-cli

• Create a manifest file Manifest file docs, targeting a valid version Runtime versions

app.json

{
    "startup_app": {
        "name": "OpenfinPOC",
        "description": "OpenFin POC",
        "url": "http://www.openfin.co",
        "uuid": "OpenfinPOC-hla8ix6e0y2iwwjlxkojkbj4i",
        "autoShow": true
    },
    "runtime": {
        "arguments": "",
        "version": "[replace this with a version]"
    }
}

• Launch OpenFin runtime once

openfin --config app.json --launch 

• Replace the OpenFin core with a built Hadouken core

grunt deploy --target=C:\Users\[username]\AppData\Local\OpenFin\runtime\[replace this with a version]\OpenFin\resources

• Now you can re-launch the OpenFin runtime with the modified Hadouken core.

openfin --config app.json --launch 

Using node-inspector

• Set breakpoints and debug using Chrome (check node-inspector's documentation on how do it)

API Documentation

API Docs for the OpenFin core are available here:

Alpha: (http://cdn.openfin.co/jsdocs/alpha/) Stable: (http://cdn.openfin.co/jsdocs/stable/)

File Structure Notes

The contents of /src/renderer/extended folder is referenced by the openfin.asar (not contained in this project)

Building for Non Commercial license distribution

In order to build the project for distribution without a commercial OpenFin license you will need to completely remove any file with the commercial license header, please review the LICENSE file.