Finsemble Seed Project
The easiest way to get started with Finsemble is to clone, or fork, the Finsemble Seed Project. The Seed Project is a very basic application built with the Finsemble framework. The Seed Project contains a build environment that the dev team at ChartIQ utilizes. All Finsemble dependencies (including OpenFin) are downloaded, installed, and configured by the build environment.
The seed project can be cloned from this public repository:
Installing Finsemble Framework
In order to install the Finsemble framework, you will need access to our private NPM repository. If you would like access to our private NPM repository, please schedule a demonstration of the Framework. We'll help you get started down the right path.
Once you have access to the private repository, open a command prompt and change to the finsemble-seed repository directory:
> npm login
You will be prompted for the username and password.
> npm install
The Finsemble Framework will now install. Note that this installs the framework into the "node-modules/@chartiq" directory of your seed project (your current directory).
> npm install -g @chartiq/finsemble-cli
This installs the command line interface (CLI). The CLI provides convenience tools for common tasks such as adding and removing components, clients, and microservices.
Building The Seed Project
The Finsemble Seed Project is a very simple application that contains a rudimentary component. You can now build and launch the application. As you build more components this process will remain the same.
To build and run the sample application:
> npm run dev
This starts up the "dev runner" which is responsible for building, watching, and launching your application. The first time you run this command, assets will be downloaded. These assets include the OpenFin runtime environment. It may take some time for this to download.
Once the assets are downloaded, the sample application will start. You will see a toolbar appear at the top of the screen. From the toolbar you can launch the sample component. For a more in-depth discussion of what's happening in the build process, see the The Finsemble Build Process overview.
Note : We recommend using "bash" for Windows instead of the standard windows command line. Bash is a little better than the Windows command line (particularly on Windows 7):
Git for Windows includes Bash:
A standalone version of Bash:
Stopping The Application
To stop the application, choose "Quit" from the toolbar. The application will stop. You can now press "ctrl-c" in your command line to quit the dev runner.
Note that you can make changes on the fly without quitting the application. The dev runner watches the code for changes and compiles when necessary. After making a change to a component, you only need to right click and then reload to get the new code. If your component has the context menu disabled, you can press
CTRL+ALT+D to open a debugger.
CTRL+ALT+R will reload your window. It's not necessary to stop and restart the application.
Note: You can always kill your application from the Windows Task Manager. Be sure to check for any stray Node processes or OpenFin processes.
A Note on Customization: Ensure the Configuration Paths Align with Your Environment
The seed project's configuration is setup to work correctly by default. However, if you customize your environemnt (such as modifying the default Node server), you may also need to update some of related configuration paths. The specifics will depend on what you customize, but the key requirement is to ensure the paths within the following three files align:
- The OpenFin manifest in configs/openfin/manifest-local.json -- along with OpenFin's settings, make sure the Finsemble paths in applicationRoot and moduleRoot are correct.
- The paths in the default Node server in server/server.js
- The paths in the server's config file in server-environment-startup.json