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 *
• OpenFin runtime executables
• Node 8.2.1
• Grunt (grunt-cli 1.2.0)
• Python 2.7.12

_______________

* 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

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)

Contributing

1. Fork it (https://github.com/HadoukenIO/core/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Read our contribution guidelines and Community Code of Conduct
4. Commit your changes (git commit -am 'Add some fooBar')
5. Push to the branch (git push origin feature/fooBar)
6. Create a new Pull Request

NOTE: Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.

Need an ICLA? Unsure if you are covered under an existing CCLA? Email [email protected]

License

The code in this repository is distributed under the Apache License, Version 2.0

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 [email protected] with questions.

Copyright 2018-2019 OpenFin

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

https://openfin.co/licensing/