Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Technical Guidelines

This section outlines the essential technical standards and best practices that developers must follow to ensure their applications meet AppNest’s quality and performance criteria. Adhering to these guidelines will facilitate a smoother review process and quicker approval for public release.

Authorization & Authentication

  • Prioritize user experience by streamlining the authorization journey.
  • The authentication process is recommended to be implemented using the SSDK CLI built-in OAuth or the IParams feature.
  • Ensure utilizing these features wherever necessary.

Error Handling

  • Adopt best practices in error handling to ensure strong and reliable security.
  • Craft user-friendly error messages that guide users to navigate easily through the app and resolve the issue.
  • Help users navigate to your support team in case of prolonged issues or important queries.

Performance

  • Avoid any tasks that may impact the overall performance of the application.
  • Regularly monitor any sort of issues or bugs that incurred on the application.
  • Apps that have persistent performance issues may be subject to removal from the Marketplace.

Data Storage

  • SSDK CLI has data methods that offer functions to set and get data from the AppNest database.
  • If the app requires storing any necessary data, it can be implemented with the help of data methods.

Best Practices

We’ve gathered a list of best practices that are highly recommended to be implemented in the AppNest apps. These practices ensure clean code and easy maintenance for us as well as the developers.

Additionally, the developers must abide by the key considerations for SSDK CLI and Twigs specified below.

SSDK CLI Key Considerations

Click here to visit the documentation

  • Please avoid making non-recommeneded changes to the SSDK CLI configuration files(manifest.json, index.html), as this could potentially cause the app to malfunction.
  • It is mandatory to use SSDK CLI’s request methods to make API calls.
  • Make sure to remove unused variables as it might throw errors when running the ssdk pack command
  • Make sure to include all the necessary functionalities for serverless applications within the server.js file.

Twigs Key Considerations

Click here to visit the documentation

  • Developers mustn’t override Twigs components’ class names to add their customized CSS. They can do so via the CSS prop in any Twigs Components.
  • Twigs offers shorthand properties where the dollar($) symbol represents a 4-point system for width and height and a 2-point system for others. Please refer to this documentation for more information.
  • It is mandatory to use the default colors codes of Twigs.
  • It is recommended to use Twigs icons as the icons’ design aligns with SurveySparrow’s official theme.
  • It’s recommended to use functional components as they are far simpler and easier to evaluate.