/core

Hadouken is an open-source runtime for building web applications with desktop experience. The OpenFin Core is the reference implementation Javascript API for the Hadouken runtime.

Primary LanguageTypeScriptOtherNOASSERTION

Hadouken Core Build Status Join the HadoukenIO Community on Slack

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.

_______________

* 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

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
npm run 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 

API Documentation

API Docs for the OpenFin core are available here:

Alpha

Stable

File Structure Notes

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

License

The code in this repository is covered by the included license.

However, if you run this code, it may call on the OpenFin RVM or OpenFin Runtime, which are covered by OpenFin's Developer, Community, and Enterprise licenses. You can learn more about OpenFin licensing at the links listed below or just email us at support@openfin.co with questions.

https://openfin.co/developer-agreement/ https://openfin.co/licensing/