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
- 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 long-running background tasks that may impact the overall speed of the application.
- Regularly monitor any sort of performance issues and 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.
- The AppNest’s data storage is highly secure and if the app requires storing any necessary data, it can be implemented with the data methods.
Best Practices - Technical
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.
Clean Code
- Structuring the code and the files is a crucial part as it is easily maintainable and can help resolve bugs quickly.
- Writing comments is a great way to help evaluators (AppNest team) understand what each part of the code does.
- Remove unnecessary console logs that display crucial information about the app such as API KEYS, USER CREDENTIALS, ETC. It is recommended to remove all unnecessary logs when publishing the app.
Twigs Key Considerations
- 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.
- Any color codes can be configured in the ThemeProvider provided by Twigs.
- It is recommended to use Twigs icons as the icons’ design aligns with SurveySparrow’s official theme. Functional components are far simpler and easier to evaluate than the Class-based components, thereby speeding up the reviewal process.
SSDK CLI Key Considerations
- Do not make non-recommended changes with SSDK CLI configuration files as it might disrupt the complete performance of the app such as index.html and manifest.json
- 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.