A web UI for exploring Vortex data files, built with React, TypeScript, and Rust/WASM, and drawn with the Vortex design system.
- Bun 1.4.3, the version in
package.json'spackageManagerfield - Node.js 24+ (Storybook and Vite run on Node)
- wasm-pack (for full app development)
- Rust toolchain (for full app development)
bun installbunfig.toml makes Bun refuse package versions younger than 7 days.
# Start dev server (builds WASM in debug mode, then starts Vite)
bun run devThe Explorer is served under /explorer/ (Vite's base), so open http://localhost:5173/explorer/.
The docs' Vercel project deploys it: under /explorer/ on the docs previews, and at the root of
explore.vortex.dev. See docs/vercel-output-config.json and .github/workflows/web-build.yml.
Storybook lets you develop and preview UI components in isolation:
bun run storybookThis starts a dev server at http://localhost:6006.
| Command | Description |
|---|---|
bun run dev |
Build WASM (debug) + start Vite dev server |
bun run build |
Production build (WASM release + Vite) |
bun run storybook |
Start Storybook dev server on port 6006 |
bun run build-storybook |
Build static Storybook site |
bun run lint |
Lint with Biome |
bun run lint:fix |
Lint with Biome and apply safe fixes |
bun run format |
Format with Biome |
bun run format:check |
Check formatting with Biome |
bun run typecheck |
Run TypeScript type checking |
bun run check |
Build WASM + Biome check + typecheck |
The Explorer uses the Vortex design system's CSS and no CSS framework.
src/styles/vortex-tokens.css,vortex-base.css, andvortex.cssare copies of the design system's styles. Change the system, then copy them again; do not edit the copies.src/styles/explorer.csslays out the Explorer on top of the system. Its classes start withx-; the system's start withvx-.- Colours come from the system's tokens, so every view follows the theme. A dtype's colour comes from its
vx-dt-*class (dtypeClassincomponents/swimlane/utils.ts). An encoding has no colour; the views name it. - The production CSP allows no inline script, so
public/theme.jssets the theme before the first paint.
Add story files alongside your components as *.stories.tsx:
import type { Meta, StoryObj } from '@storybook/react-vite';
import { MyComponent } from './MyComponent';
const meta: Meta<typeof MyComponent> = {
component: MyComponent,
};
export default meta;
type Story = StoryObj<typeof MyComponent>;
export const Default: Story = {
args: {},
};vortex-web/
crate/ # Rust WASM crate (vortex bindings)
src/ # React/TypeScript frontend
styles/ # The design system's CSS, and the Explorer's own
wasm/pkg/ # Generated WASM bindings (not checked in)
.storybook/ # Storybook configuration
public/ # Static assets