Sfmc-Studio app submission

[sukhmantru]

Purpose

To list the new app on the contentful

[lambardi]

Hey @sukhmantru

Here is the documentation for private app installation parameters:
https://www.contentful.com/developers/docs/extensibility/app-framework/app-parameters/#installation-parameters
(See the subheader "Private App Installation Parameters")

And here are the specifics on the feedback we discussed today:

The engineering team managing the Contentful marketplace began a review of the SFMC-Studio app (#2200) and wanted to share some initial feedback:

• Our intention in having Contentful Marketplace apps store their frontend code in our Marketplace Apps Repo is that then the frontend code for your app will be uploaded and hosted by Contentful in the app definition that we create for your app.

• • Contentful App Hosting only allows hosting of static websites. Next.js apps that do not use server-side code could be exported as a static website (https://nextjs.org/docs/pages/building-your-application/deploying/static-exports)
• • However, your app uses features that require a node-js server (api routes, middleware, and MongoDB)
• • • Example API Route: https://github.com/contentful/marketplace-partner-apps/pull/2200/files#diff-cf166168395311f7e8439ac47c1bdcb11809af3bd2332eff91835bccdd06829bR1
• • • Example middleware: https://github.com/contentful/marketplace-partner-apps/pull/2200/files#diff-78663b646000ef5c3276ea895a0741953b2450a785f88f3789408e5f67ca6ba9R1
• • • Example MongoDB/Mongoose usage: https://github.com/contentful/marketplace-partner-apps/pull/2200/files#diff-dd33ec086f08c1881fc21e646ce17bb4ec1a9678651e9fbb84c0abc1d906aff7R1

• It appears that the app relies on some environment variables; we have not been managing partner developer environment variables in this repo for other apps (e.g. https://github.com/contentful/marketplace-partner-apps/pull/2200/files#diff-dd33ec086f08c1881fc21e646ce17bb4ec1a9678651e9fbb84c0abc1d906aff7R18)

• The app should have some basic unit tests in order to verify core app functionality

• • t looks like this app has test files from our create-contentful-app template, but these should be updated to test basic app functionality
• • The existing test template files are duplicated (e.g. locations are found here and here)

• The app should have a README that outlines information about the app such as local setup and app configuration
  https://github.com/contentful/marketplace-partner-apps/pull/2200/files#diff-1a23cd71b3b0d64f107390fb3293c832744e071da5e6dd4fc9ad209593d65eadR1

• The app should have code formatting and linting set up (e.g. prettier and ESLint)

• • The lint script is here, but there are no configuration files: https://github.com/contentful/marketplace-partner-apps/pull/2200/files#diff-e34855fa9ce408ff9097d7fe68588cc31ec6a4ce137b42acfac7292a3ab03054R9

• Moment is being used as a dependency, however this is a legacy project and now in maintenance mode. Perhaps another solution for date parsing and manipulation could be used? https://momentjs.com/docs/#/-project-status/
  https://github.com/contentful/marketplace-partner-apps/pull/2200/files#diff-e34855fa9ce408ff9097d7fe68588cc31ec6a4ce137b42acfac7292a3ab03054R31

• If the app requires that a customer submits a secret as part of the configuration, this should use our private app installation parameters or should be obfuscated (https://github.com/contentful/marketplace-partner-apps/pull/2200/files#diff-cdbfe1461829567b1c594be25f95855602a24a52ac24f9f611e21204b27ecd9dR330)

• • https://www.contentful.com/developers/docs/extensibility/app-framework/app-parameters/#what-are-parameters
• • https://www.contentful.com/developers/docs/extensibility/app-framework/app-parameters/#private-installation-parameters

• A license file should be added for your app. You can review other apps in this repo as a reference (e.g.: https://github.com/contentful/marketplace-partner-apps/blob/main/apps/wix/LICENSE).

• Other considerations:

• • Confirm that your app adheres to OWASP standards: https://owasp.org/www-project-top-ten/
• • Confirm that your app meets basic accessibility standards: https://developer.mozilla.org/en-US/docs/Learn/Accessibility/HTML