You will need:
- A computer running Windows 8 or higher, or a Mac running Parallels, VirtualBox or similar, to allow Windows 8 or higher to be run
- A web browser, preferably Google Chrome
- A code editor of your choice: Atom, Visual Studio Code, Notepad++
- An internet connection.
- Terminal Apps: The Git Bash terminal tool comes with the whole Git package and is a failrly foolproof way of running npm commands.
First create a directory in the root of your project called src. You may structure your project any way you see fit; this structure is not de rigueur for OpenFin. In src, we will create an HTML file to be the main app file, and we will follow convention and call it index.html. Add the following code to src/index.html to create a minimal HTML page:
<html>
<head></head>
<body>
<h1>Hello World</h1>
</body>
</html>
This will allow you to develop your app on your local machine. Other methods and technologies are available and will work just as well (e.g. Apache or IIS) but for this example, we will be using a simple Node/Express server. This requires Node to be installed.
Create a file called server.js at same level as the src directory we created in Step 1. Add the following code:
var express = require('express')
, http = require('http')
, path = require('path');
var app = express();
app.set('title','OpenFin DemoApp');
app.use(express.static(path.join(__dirname, 'src')));
/* serves main page */
app.get('/', function (req, res) {
res.sendFile("src/index.html", {"root": __dirname});
});
/* process.env.PORT is used in case you want to push to Heroku, for example, here the port will be dynamically allocated */
var port = process.env.PORT || 9070;
http.createServer(app).listen(port, function(){
console.log('Express server listening on port ' + port);
});
Now, you need to add some dependencies for the server. Using a command-line terminal, navigate to the root directory of your project and run:
$ npm init
Which will take you through the steps to create a package.json file to store dependency information and more about your project. Then followed by:
$ npm install --save express
This will install express, saving the dependency information to your package.json file.
If you are unfamiliar with using NPM for package dependencies, you can read their documentation here.
Start the express server. Still in the terminal, type:
$ node server
You should see this message in the terminal: Express server listening on port 9070.
Keep the terminal window open (closing it will close the server). Open your web browser at http://localhost:9070.
You should see your Hello World index html page.
You now have an ultra-minimal web app ready to packaged up as an OpenFin app.
This is the file which will specify how your OpenFin app appears and behaves.
Create a file, in the src directory, called app_local.json. You may name the file whatever you like as long as it is correctly targeted when generating the installer (of which, more later). You may create a number of app.json files, e.g. for local, alpha, beta and staging versions of your app.
Add the following code to the app_local.json:
{
"devtools_port": 9090,
"startup_app": {
"name": "OpenFin Demo App",
"description": "A demo OpenFin app",
"url": "http://localhost:9070",
"uuid": "openfin-demo-application",
"autoShow": true
},
"runtime": {
"arguments": "",
"version": "stable"
},
"shortcut": {
"company": "OpenFin",
"description": "OpenFin appseed",
"name": "OpenFin appseed"
}
}
A full list and explanation of configurable properties may be found here.
The crucial properties are:
- url: This is the path to the main index.html file for the application.
- runtime:{"version":"stable"} This is the version of the runtime you wish to target. "stable" gives you the most recent stable build.
- uuid: This is the unique ID of the app you are running. You cannot have two apps with the same ID running on the same desktop.
The installer is generated via a url, like this:
https://install.openfin.co/download?fileName=openfin_appseed&config=http://localhost:9070/app_local.json
The parts of the url are as follows:
- https://install.openfin.co/download : The path to OpenFin's app generator-this must not be altered.
- ?fileName=nameOfTheGeneratedInstallerApp : The name you wish the installer to have once downloaded.
- &config=http://localhost:9070/app_local.json : The url to the config file created in step 2.1.
Navigate to the URL in a web browser. It will download an .exe file. Run the file. You should see your OpenFin Hello World app.
Your app, as built in the preceeding steps, will run exactly the same in Chrome and OpenFin. When developing real world apps, reusability is often a primary concern. You may wish for your app to function as an OpenFin app, but also perform, unmodified, on the web and mobile too.
OpenFin's additional functionality will (most likely) account for a small percentage of your code so it is wise to write a conditional statement to discover if you are running within OpenFin's Runtime, and the OpenFin API is available or degrade gracefully on Web and mobile. For example:
document.addEventListener("DOMContentLoaded", function(){
init();
});
function init(){
/* Code common to both OpenFin and browser to go above.
Then the specific code for OpenFin and browser only to be
targeted in the try/catch block below.
*/
try{
fin.desktop.main(function(){
initWithOpenFin();
})
}catch(err){
initNoOpenFin();
}
};
function initWithOpenFin(){
alert("OpenFin is available");
// Your OpenFin specific code to go here...
}
function initNoOpenFin(){
alert("OpenFin is not available - you are probably running in a browser.");
// Your browser-only specific code to go here...
}
Add the link to the javaScript into your index.html.
--
If you would rather cut-to-the-chase and not follow the steps above manually, clone this repository.
This is a vanilla JavaScript app seed for developing OpenFin apps. It is free from frameworks and build systems, though you may add them as you see fit.
It has a simple Node/Express server for local development.
Clone the repo and run:
$ npm install
NB: On a Mac, you may need to type sudo npm install.
Navigate to the root folder where server.js resides with your command line tool and run:
$ node server
This should start a simple Node server at http://localhost:9070, then, click the link below to install as an OpenFin app.
If you wish to change to localhost port, you will need to change the references in server.js, app.json, and in the installer.
MIT
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 [email protected] with questions.
https://openfin.co/developer-agreement/
https://openfin.co/licensing/
Please enter an issue in the repo for any questions or problems.
Alternatively, please contact us at [email protected]