Altertable Data App

TypeScript contracts, a data client, server handlers, and React UI for building interactive apps with Altertable data.

Installation

# npm
npm install @altertable/data-app

# pnpm
pnpm add @altertable/data-app

# Bun
bun add @altertable/data-app

For React apps, also install React 19.2 or newer and React DOM 19.2 or newer, then import the stylesheet once in your browser entry:

import '@altertable/data-app/react/styles.css';
import { mountDataApp } from '@altertable/data-app/react';

Documentation

| Entry | Use | | ----------------------------------------- | ----------------------------------------------------- | | /contract | Define typed operations, parsers, and date ranges | | /client | Call server operations with fetch | | /server | Authorize and execute requests on a hosted server | | /server/bun | Serve an app locally with Bun | | /embed | Host URL apps or sandboxed JavaScript bundles | | /bootstrap | Embed the standalone bootstrap script in backend HTML | | /react/embed | Embed apps with React shells and bridges | | /react | Compose views, filters, widgets, and request states | | /react/styles.css | Load the React UI stylesheet | | /config | Define app identity and scope | | /appearance | Configure brand tokens and viewer theme | | /format | Format dates, counts, ratios, and currencies |

Start with app authoring for the complete data flow. The package ships these docs alongside its built JavaScript and declarations. For agent-assisted work, direct your agent to node_modules/@altertable/data-app/AGENTS.md.

Starter example

The runnable starter includes app configuration, server operations, a React connectivity screen, and agent instructions. Use it as the starting point for an app that consumes the public package.

Development

bun install --frozen-lockfile
bun run check

See Contributing for repository structure and focused checks. Releases use Release Please and npm trusted publishing.

License

MIT