Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 3.84 KB

README.md

File metadata and controls

31 lines (24 loc) · 3.84 KB
Raw

Finsemble Logo

Finsemble Seed Project

To get started with Finsemble, check out the seed project tutorial. This tutorial walks you through setting up the seed project and introduces you to the basic concepts of developing a Finsemble smart desktop.

For everything you need to know about Finsemble, including our API documentation, check out the developer documentation.

Project structure

The Finsemble seed project provides a basic structure to help developers get up and running as quickly as possible. The seed project provides the skeleton of a Finsemble application that can be extended to suit your organization's needs. It also includes some functionality to make development faster and easier, like a basic build process.

  • gulpfile.js - The main gulpfile for the project includes the basic tasks used to build and run a Finsemble application for development.
  • gulpfile-extension.js (optional) - File that can be used to add/modify the functionality of the gulpfile. This file is included to prevent conflicts when upgrading your base project.
  • build/webpack - Includes all of the files used by the seed project to build the application.
    • webpack.finsemble-built-in.entries.json - This specifies the entry and output files for the files built for a default Finsemble smart desktop.
    • webpack.components.entries.json - This file is where developer-added files should be listed. This file is empty in the base Finsemble seed project to prevent merge conflicts when updating the seed project.
    • webpack.adapters.entries.json - This file is for any storage adapters that need to be built. They are no longer housed in the same webpack configuration as components, as they cannot use the same plugins as components use.
  • configs/application - This folder contains all of the base configurations for the Finsemble application. component.json, config.json and services.json are empty and developer-added configuration should go here. The files in this folder are merged together to build the application configuration. This configuration can be changed at run time using dynamic configuration.
  • configs/openfin - Contains the application manifest used to start up the Finsemble application. The default manifest for development is included, and additional configurations can be placed in this folder.
  • configs/other/server-environment-startup.json - Used to define the development and production server configurations used by the Finsemble application.
  • server - Contains the server that hosts the built dist folder for development purposes.
    • server/server-extensions.md - Optional file that can be used to add functionality to the development server.
  • src - The folder where your Finsemble components should be placed for the Finsemble build process.
  • src-built-in - Includes the source for the default UI components included with the Finsemble seed project. These files can be extended as desired, but, if you do extend these components, we recommend you copy the folder to the src directory to prevent merge conflicts when upgrading the seed project.
    • src-built-in/adapters - Contains an example Storage Adapter that saves data to local storage.
    • src-built-in/components/assets - Contains the SASS, CSS and images used to create Finsemble's look and feel.
  • tutorials - Contains the source for the components used by our seed project tutorial.

Upgrading

If you are moving from a version of the Finsemble seed project older than 2.3, please see the instructions here.