
# Build apps

> Part of Build and extend

Build powerful apps that integrate natively into Atlan's metadata platform.

- [App Framework](https://docs.atlan.com/llms/platform/build-apps/app-framework/llms.txt): Understand the Atlan App Framework and how it lets you build durable, fault-tolerant applications on Atlan's metadata platform.
- [Apps and tasks](https://docs.atlan.com/llms/platform/build-apps/apps-and-tasks/llms.txt): Understand the App and @task primitives—the building blocks of every App Framework application.
- [Inputs and outputs](https://docs.atlan.com/llms/platform/build-apps/inputs-and-outputs/llms.txt): Typed Input and Output contracts—how the App Framework validates data between tasks and ensures safe serialization.
- [Credentials](https://docs.atlan.com/llms/platform/build-apps/credentials/llms.txt): Understand how the App Framework keeps secrets out of your code using typed credential references—declare, resolve, and access credentials safely in tasks and handlers at runtime.
- [Handlers](https://docs.atlan.com/llms/platform/build-apps/handlers/llms.txt): Implement the Handler—your app's HTTP interface—to validate credentials, run preflight checks, and surface available metadata for the Atlan setup form.
- [Templates](https://docs.atlan.com/llms/platform/build-apps/templates/llms.txt): Pre-built App subclasses for common extraction patterns—start from a template instead of from scratch.
- [SQL](https://docs.atlan.com/llms/platform/build-apps/sql/llms.txt): Extract SQL metadata using SqlApp—databases, schemas, tables, columns, views, and procedures from any SQL source.
- [Built-in APIs](https://docs.atlan.com/llms/platform/build-apps/api/llms.txt): Comprehensive REST APIs for managing apps, authentication, metadata operations, and configuration.
- [Authentication & metadata](https://docs.atlan.com/llms/platform/build-apps/auth-metadata/llms.txt): Source system connectivity and metadata operations including credential validation, metadata retrieval, and preflight checks.
- [Configuration management](https://docs.atlan.com/llms/platform/build-apps/configuration-management/llms.txt): App and system configuration management including configuration retrieval, updates, and app configuration UI.
- [Infrastructure management](https://docs.atlan.com/llms/platform/build-apps/server-management/llms.txt): Monitor and manage the App Framework server with health checks, readiness probes, and graceful shutdown operations.
- [UI & documentation](https://docs.atlan.com/llms/platform/build-apps/ui-documentation/llms.txt): UI and documentation endpoints for serving the application homepage, observability dashboard, and static documentation files.
- [Lifecycle management](https://docs.atlan.com/llms/platform/build-apps/workflow-management/llms.txt): Complete app lifecycle management including HTTP-triggered execution, status monitoring, and app termination.
- [Configuration](https://docs.atlan.com/llms/platform/build-apps/configuration/llms.txt): Environment variables and configuration options for App Framework applications.
- [Architecture (advanced)](https://docs.atlan.com/llms/platform/build-apps/architecture/llms.txt): Under-the-hood: how the App Framework's execution engine and infrastructure runtime work together.
- [Quickstart](https://docs.atlan.com/llms/platform/build-apps/tutorials/llms.txt): Install the App Framework, run your first sample app, and build a custom application—step by step.
- [Set up your development environment](https://docs.atlan.com/llms/platform/build-apps/set-up-development-environment/llms.txt): Install the App Framework Python package and prepare your local environment to build and run Atlan apps.
- [Run your first sample app](https://docs.atlan.com/llms/platform/build-apps/run-sample-app/llms.txt): Clone and run the Hello World sample app to see the App Framework's durable execution in action.
- [Build your first app](https://docs.atlan.com/llms/platform/build-apps/build-first-app/llms.txt): Edit the Pkl contract to add a new input field, use it in a task, add a third task, and pin the contracts with tests.
- [Sample apps](https://docs.atlan.com/llms/platform/build-apps/sample-apps/llms.txt): Reference applications built with the Atlan App Framework.
- [Test your apps](https://docs.atlan.com/llms/platform/build-apps/test-framework/llms.txt): Testing strategy for App Framework applications—unit, integration, and end-to-end tiers, with scope, speed, and infrastructure requirements for each.
- [Unit testing](https://docs.atlan.com/llms/platform/build-apps/unit-tests/llms.txt): Test App Framework tasks and handlers in isolation using mock infrastructure—no external services required.
- [Integration testing](https://docs.atlan.com/llms/platform/build-apps/integration-tests/llms.txt): Write and run integration tests for App Framework connectors using scenarios, assertions, and locally running Dapr and Temporal services.
- [End-to-end testing](https://docs.atlan.com/llms/platform/build-apps/e2e-tests/llms.txt): Validate the complete production data flow for App Framework connectors with a live Atlan tenant using BaseE2ETest or SQLAppE2ETest.
- [Package app with Docker](https://docs.atlan.com/llms/platform/build-apps/package-app-with-docker/llms.txt): Build Docker images for your Atlan applications to create OCI-compliant containers for deployment within Atlan's runtime environment
- [Push images to Harbor registry](https://docs.atlan.com/llms/platform/build-apps/push-images-to-harbor-registry/llms.txt): Push your containerized application images to Atlan's Harbor registry for staging and deployment within the partner program
- [Embed external apps](https://docs.atlan.com/llms/platform/build-apps/embed-external-apps/llms.txt): Embed your web app so users can open it from the sidebar or asset profiles.
- [Develop your app](https://docs.atlan.com/llms/platform/build-apps/develop-locally/llms.txt): Run your app on localhost and authenticate to your tenant to test API calls before embedding.
- [Embed your app](https://docs.atlan.com/llms/platform/build-apps/embed-in-atlan/llms.txt): Deploy your app, set CSP and authentication, and register it so the product can load it in an iframe.
- [Register your app](https://docs.atlan.com/llms/platform/build-apps/register-your-app/llms.txt): Share app details with your Atlan admin or Atlan support so your embedded app appears in the sidebar or on asset profiles.
- [App registration](https://docs.atlan.com/llms/platform/build-apps/register-app/llms.txt): Configure iframe URL, allowed origins, and where the app appears (sidebar, asset tabs, conditional rules).
- [Auth payload](https://docs.atlan.com/llms/platform/build-apps/auth-context/llms.txt): Token, user identity, and page in ATLAN_AUTH_CONTEXT (for example, asset GUID in page.params).
- [Send and receive messages](https://docs.atlan.com/llms/platform/build-apps/postmessage-reference/llms.txt): postMessage types and payloads: send IFRAME_READY or request a token; handle ATLAN_AUTH_CONTEXT.
- [Choose right way to automate Atlan](https://docs.atlan.com/llms/platform/build-apps/choose-how-to-automate/llms.txt): Pick the simplest programmatic mechanism for a metadata task—API, SDK, packages, MDLH, or MCP—and design it to run safely at scale.
- [API limits, batching, and automation reference](https://docs.atlan.com/llms/platform/build-apps/api-limits-and-automation/llms.txt): Rate limits, batching sizes, retry/backoff standards, client requirements, and hard constraints for Atlan's programmatic surfaces—REST API, SDKs, webhooks, governance workflows, and the MCP server.
- [Custom solutions](https://docs.atlan.com/llms/platform/build-apps/custom-solutions/llms.txt): Learn about custom solutions.
- [Embedded app connection and authentication issues](https://docs.atlan.com/llms/platform/build-apps/connection-and-authentication-issues/llms.txt): Troubleshoot timeout, iframe loading, and 401 errors when your app is embedded in Atlan.
- [Security for embedded apps](https://docs.atlan.com/llms/platform/build-apps/embedded-apps-security/llms.txt): Common security questions when embedding your app in Atlan: authentication, tokens, and CSP.
- [App Marketplace](https://docs.atlan.com/llms/platform/build-apps/app-marketplace/llms.txt): Frequently asked questions about building, publishing, and distributing apps through the Atlan App Marketplace using the App Framework.
