Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 2.76 KB

ProjectStructure.md

File metadata and controls

49 lines (31 loc) · 2.76 KB

Project structure

Below is a brief outline of what's included in the seed project.

  • assets - Contains the CSS and images used to create the SmartDesktop's look and feel.

  • build/webpack - Includes all of the files used by the seed project to build the application.

    • webpack.finsemble-built-in.entries.json - Specifies the entry and output files for the files built for a default SmartDesktop.

    • 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 - Specifies storage adapters to be built.

  • configs - Contains all the necessary configuration for the SmartDesktop

    • configs/other/server-environment-startup.json - Used to define the development and production server configurations used by the Finsemble application.

    • configs/application - Contains all of the base configurations for the Finsemble application. The files in this folder are merged together to build the application configuration. This configuration can be changed at run time using dynamic configuration. 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.

  • 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. It also includes the source for the default UI components included with the Finsemble seed project.

    • src/adapters - Contains an example Storage Adapter that saves data to local storage.

    • src/components - Default location of all the SmartDesktop's components, including built-in components. You can add to this folder automatically using Finsemble CLI (run finsemble-cli add component --help for more info).

    • src/preloads - Default location for preload scripts.

    • src/services - Default location for user-defined services. You can to this folder automatically using the Finsemble CLI (run finsemble-cli add service --help for more info).

  • gulpfile.js - The main gulpfile for the project includes the basic tasks used to build and run a Finsemble application for development.

  • gulpfile-extensions-example.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.