Contentstack App Lifecycle: A Developer's Guide
Contentstack applications offer powerful ways to extend the platform's functionality and customize your content management experience. This documentation will guide you through the lifecycle of your app, depending on whether you are building a Standard app or a Machine-to-Machine app.
Standard App Lifecycle
- Creation and Setup (Developer Hub):
- App Definition: Define your app's name, description, and scope.
- Development: Using Contentstack's APIs and SDKs, you will build the core functionality of your app, design its user interface using the Venus design components, and integrate it with any necessary systems.
- App Hosting (Developer Hub):
- Hosting Options: You can choose any hosting solution, but we recommend using Contentstack Launch for seamless integration with the Contentstack ecosystem.
- You can also host your app locally during initial development or use your own hosting solution.
- Hosting Options: You can choose any hosting solution, but we recommend using Contentstack Launch for seamless integration with the Contentstack ecosystem.
- Installation and Testing (Developer Hub):
- Installation: Install your app within your organization from Developer Hub.
- This requires Admin access to the Organization or Stack, depending on the app type.
- Testing: Thoroughly test your app in a test stack to ensure it works as intended.
Note: If you don’t plan to list your application publicly, then you can ignore the next step and use your app privately in your organization.
- Installation: Install your app within your organization from Developer Hub.
- Public Listing and Release (Optional):
- Public Listing Submission: If you want to release your app publicly, you will need to submit it to Contentstack for review and approval. Contentstack's team will assess your app to ensure it meets their quality and functionality standards.
- You can find details on the submission process here: Submit your app for review
- Marketplace Discovery: Once your app is approved and listed in the Marketplace, it becomes discoverable to all Contentstack users. Users can browse and find your app based on its category, features, or other criteria.
- Public Listing Submission: If you want to release your app publicly, you will need to submit it to Contentstack for review and approval. Contentstack's team will assess your app to ensure it meets their quality and functionality standards.
- App Updates and Changes (Developer Hub):
- Versioning and Updates: As your app evolves and as you make changes to your app, new app Versions will be generated.
- Private apps will have these versions immediately available to update your app.
- Public apps will require you to submit your app for review for any changes you would like to make public.
- Versioning and Updates: As your app evolves and as you make changes to your app, new app Versions will be generated.
Machine to Machine App Lifecycle
- Creation and Setup (Developer Hub):
- App Definition: Define your app's purpose and scope. You will be creating a Machine to Machine app that does not have a user interface.
- Development: Using Contentstack's APIs and SDKs, you will build the core functionality of your app and integrate it with any necessary systems.
- App Configuration: Set up your app's permissions and OAuth 2.0 integrations to define its access and behavior.
- Authorization:
- Authorization: Contentstack admins can authorize the app to access their data or resources. This process typically involves authentication using OAuth 2.0.
Important Considerations for All Apps
- Security: Contentstack provides robust security measures, but developers should implement secure coding practices and handle sensitive data responsibly.
- Documentation: Clear and concise documentation is crucial for both app developers and end users.
- Support: Providing ongoing support for your app is crucial to ensure user satisfaction and maintain a positive experience.