Getting Started

Welcome to the apx documentation. apx is a reliable, feature-full, human and LLM friendly development toolkit for building Databricks Apps.

Quick Start

Initialize a new project with a single command:

uvx --index https://databricks-solutions.github.io/apx/simple apx init

This launches an interactive prompt that guides you through:

• Naming your app
• Selecting a Databricks profile
• Setting up AI assistant rules
• Choosing a template

Prerequisites

Before getting started, ensure you have:

• uv - Fast Python package manager (install)
• Databricks CLI - For deployment (install)

Note: Bun is bundled with apx and does not need to be installed separately.

Documentation

Project Structure

After initialization, your project will have this structure:

Quick overview of the most important files and directories:

• package.json: Frontend dependencies and scripts. Almost no need to edit this file manually.
• pyproject.toml: Python package metadata. Almost no need to edit this file manually.
• databricks.yml: Databricks Bundle configuration for deployment.
• src/: Source code for the app.
• src/<app_name>/ui/: React + Vite frontend.
• src/<app_name>/backend/: FastAPI backend.

Development Workflow

1. Start the dev server

   uv run apx dev start

2. Add UI components

   uv run apx components add button card

3. Check your code

   uv run apx dev check

4. Build for deployment

   uv run apx build

5. Deploy to Databricks

   databricks bundle deploy -p <your-profile>

Stack

apx is built on modern, production-ready technologies:

Next Steps