Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,18 @@ export DATABRICKS_PROFILE=your-profile # Databricks profile name. Used as a Data
export DATABRICKS_APP_NAME=your-app-name # The name of the app to deploy. If not provided, it will be prefixed with the username.
export DATABRICKS_WORKSPACE_DIR=your-workspace-dir # The source workspace directory to deploy the app from. It will be used to construct the absolute path: /Workspace/Users/{your-username}/{workspace-dir}
```

## Contributing to AppKit documentation

The `docs/` directory contains the AppKit documentation site, built with Docusaurus.

**Working with docs:**

```bash
# From root
pnpm docs:dev # Start dev server
pnpm docs:build # Build docs
pnpm docs:serve # Serve built docs
```

See [docs/README.md](./docs/README.md) for more details.
36 changes: 21 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# AppKit

> [!WARNING]
> ## ⚠️ PREVIEW - NOT FOR PRODUCTION USE
Build Databricks Apps faster with our brand-new Node.js + React SDK. Built for humans and AI.

> [!WARNING] PREVIEW - NOT FOR PRODUCTION USE
>
> **This SDK is in preview and is subject to change without notice.**
>
Expand All @@ -11,25 +12,30 @@
> - 📝 **Use for development and testing only**
>

## Contributing
## Introduction

See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and contribution guidelines.
AppKit is a TypeScript SDK for building production-ready Databricks applications with a plugin-based architecture. It provides opinionated defaults, built-in observability, and seamless integration with Databricks services.

## Documentation
AppKit simplifies building data applications on Databricks by providing:

- **Plugin architecture**: Modular design with built-in server and analytics plugins
- **Type safety**: End-to-end TypeScript with automatic query type generation
- **Production-ready features**: Built-in caching, telemetry, retry logic, and error handling
- **Developer experience**: Remote hot reload, file-based queries, optimized for AI-assisted development
- **Databricks native**: Seamless integration with SQL Warehouses, Unity Catalog, and other workspace resources

The `docs/` directory contains the AppKit documentation site, built with Docusaurus.
## Getting started

**Working with docs:**
Follow the [Getting Started](https://databricks.github.io/appkit/docs/) guide to get started with AppKit.

```bash
# From root
pnpm docs:dev # Start dev server
pnpm docs:build # Build docs
pnpm docs:serve # Serve built docs
```
## Documentation

See [docs/README.md](./docs/README.md) for more details.
📖 For full AppKit documentation, visit the [AppKit Documentation](https://databricks.github.io/appkit/) website.

👉 For AI/code assistants:
- Use [llms-compact.txt](./llms-compact.txt) for quick usage patterns.
- See [llms.txt](./llms.txt) for full guidance and anti-patterns.
- See [llms.txt](./llms.txt) for full guidance and anti-patterns.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and contribution guidelines.
8 changes: 8 additions & 0 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,14 @@ const config: Config = {
],

themeConfig: {
announcementBar: {
id: "preview-not-for-production",
content:
"⚠️ AppKit is in an early development phase and is subject to change without notice. <strong>DO NOT</strong> use in production environments.",
backgroundColor: "#f0f0f0",
textColor: "#000000",
isCloseable: true,
},
colorMode: {
respectPrefersColorScheme: true,
},
Expand Down