You can use the manifest.json file (also called the app manifest) to specify,
- App start-up parameters - such as the platform version used to build the app, the node version used, and so on.
- App property parameters - such as the locations where the app is deployed, and so on.
When you use the fdk create command and generate the front-end app files, the app manifest generated contains default attributes. To configure the app manifest for your app, you can modify the attribute values, delete (non-mandatory) attributes that your app does not require, or add appropriate attributes.
After creating the front-end app files, to configure the app manifest, do one of the following:
- From the app’s root directory, navigate to manifest.json and manually configure the attributes. Or
- Use the fdk generate command to edit the default manifest.json.
App manifest attributes - description and how to configure them
- platform-versionstringRequired
Platform version you use to build the app. This value is auto-generated when you create the default app files by using the fdk create command.
When you build a new app, ensure that you are on the latest version of the platform . If you update your existing app that was built with an earlier platform version, ensure to move to the latest version of the platform. For migration steps, see Migration guide. - productobjectRequired
Associates a Freshworks product with the information that is necessary to render the app on the specified product.
- enginesobject
Node.js and FDK versions that are used to build the app. When you create the front-end app files by using the fdk create command, this attribute value is auto-populated.
Creating an app: If you use FDK 7.0.0 or later versions to create an app, the engines attribute is available by default as part of the manifest.json file.
Migrating an app: If you have an existing app that is built using FDK 6.x.x or an earlier version, ensure to,- Install the latest FDK version.
- Run fdk validate to migrate the app to the latest FDK version. As part of this process, the FDK updates the engines attribute.
- Retest the app.
- appobject
Information pertaining to the app metrics, auto-generated when the app is created.
Note:Currently, this object is auto-generated only when the app uses any Freddy Copilot features.