ℹ️ OpenFin Workspace: OpenFin Workspace is a commercial product and this repo is for evaluation purposes (See LICENSE.MD). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin (see manifest). Please contact us if you would like to request a developer evaluation key or to discuss a production license.
Using a simplified approach to populating a platform this basic example will use the list of application defined in your manifest.fin.json to populate all the Workspace components Home, Store, Dock and Notifications.
This example assumes you have already set up your development environment
To run this sample you can:
- Clone this repo and follow the instructions below. This will let you customize the sample to learn more about our APIs.
- Launch the Github hosted version of this sample to interact with it by going to the following link: Github Workspace Starter - Workspace Platform Starter Basic
- Install dependencies and do an initial build. Note that these examples assume you are in the sub-directory for the example.
npm run setup-
Optional (if you wish to pin the version of OpenFin Workspace to version 16.0.0 and you are on Windows) - Set Windows registry key for Desktop Owner Settings. This example runs a utility dos.mjs that adds the Windows registry key for you, pointing to a local desktop owner settings file so you can test these settings. If you already have a desktop owner settings file, this script prompts to overwrite the location. Be sure to capture the existing location so you can update the key when you are done using this example.
(WARNING: This script kills all open OpenFin processes. This is not something you should do in production to close apps as force killing processes could kill an application while it's trying to save state/perform an action).
npm run dos- Start the test server in a new window.
npm run start- Start Your Workspace Platform (this starts Workspace if it isn't already running).
npm run client-
Type any character into the search box to show the default list of Applications sourced from the manifest.
-
Build the project if you have changed the code.
npm run build
This is a headless application. If you wish to debug it then you can update the manifest file and set platform.autoShow to true. Otherwise you can use Process Manager (which is included in your list of apps).
The Server in this example provides two sets of content over HTTP GET.
- A Desktop Owner Settings file to pin the version of OpenFin Workspace (Optional)
- Examples of View and Snapshot Manifest Types
For a more detailed look at how each component is used please see the individual examples.
This is an example of how to use our APIs to configure OpenFin Workspace. It's purpose is to provide an example and provide suggestions. This is not a production application and shouldn't be treated as such. Please use this as a guide and provide feedback. Thanks!