Application Information

This guide will explain how FrontPanel apps provide information related to the app (description, usage instructions, version history, etc.) and make it available in the app info dialog presented in the launcher.

App Info File

FrontPanel apps specify the information to display in the app info dialog in an APP-INFO.md file located at the root of the project. Note: The contents of this file is formatted using markdown.

Packaging the App Info file

The APP-INFO.md file needs to be included in the final application package that is installed in the app launcher, and must be located in the assets/text directory within the built package. (assets/text/APP-INFO.md)

In order to package the APP-INFO.md file in the assets/text directory of the package, a step in the webpack.common.js file is specified to copy the file from the source location and place it in the proper location in the app package.

    new CopyWebpackPlugin({
      patterns: [
        { from: 'frontpanel-app.json', to: 'frontpanel-app.json' },
        { from: 'APP-INFO.md', to: 'assets/text' },
        { from: 'assets/frontpanel-app-icon.svg', to: 'assets/images' }
      ],
    }),Code language: JavaScript (javascript)

This step ensures the npm run pack command will produce the app.asar package with this file included. When this app is installed in the launcher, displaying the application information for the app will display the contents of the APP-INFO.md file.