mirror of
https://github.com/arsvendg/Stirling-PDF.git
synced 2026-07-16 19:33:11 +02:00
Portal (#6391)
# Description of Changes ## What & why This PR introduces the **Stirling developer portal** — a new control-plane frontend that sits alongside the existing PDF editor — plus the shared design system and workspace structure needed to host both apps in one frontend. The portal is the parent product surface: where users connect sources, compose pipelines, wire agents, and manage usage / billing / infrastructure, with the PDF editor as one capability inside it. This PR lays the **foundation** — workspace reshape, design system, app shell, navigation, and a mock-driven home — rather than wiring real backends (those surfaces are placeholders for follow-up phases). ## What's in this PR **1. Frontend repo reshape (`frontend/src/` → `frontend/editor/`)** The existing editor app moved under `frontend/editor/`, so `editor`, `portal`, and `shared` are siblings in one workspace. All references were updated accordingly: `LICENSE`, `.dockerignore`, `.gitignore`, build/sign shell scripts, the GH language-check script, the Taskfile, and Docker config. **No editor source logic changed — path references only.** **2. New shared design system (`frontend/shared/`)** - **Design tokens** in `tokens.css` as the single runtime source of truth (light/dark, category accents, gradients). `tokens.ts` now holds only the `Tier` type — the old JS palette mirror was removed (nothing consumed it and it had drifted). - ~30 framework-light **components** (Card, Button, Input, Select, Tabs, Modal, Drawer, Toast, MetricCard, StatusBadge, Skeleton, EmptyState, …) with Storybook stories. - **Typed data catalogues**: `endpoints.ts` (10 verticals / 64 endpoints) and `ops.ts`. **3. New developer portal app (`frontend/portal/`)** - App shell: `Header`, `Sidebar`, `AssistantPanel`, search modal, notifications, tier switcher, theme toggle, MSW toggle. - **Tier-aware** home (free / pay-as-you-go / enterprise): KPI strip, 30-day usage chart, onboarding checklist, quick actions, recent activity, region health, product grid, and a curated **"Popular use cases"** teaser. - **Documents** view hosting the full, tab-filterable endpoint catalogue. - Placeholder views for Sources / Pipelines / Agents / Editor / Infrastructure / Usage & Billing / Developer Docs / Settings (follow-up phases). - **MSW-mocked** API layer: `api/*` issues real `fetch`, intercepted by mocks in dev/Storybook; pointing at a real backend is just a matter of not registering MSW. `react-router` URLs; Tier / View / UI contexts. **4. Tooling & guardrails** - ESLint extended to `portal` + `shared`, with **layering-boundary rules**: `shared/` may depend only on third-party packages and itself (no `@app` / `@portal` / `@core` / `@proprietary` / Tauri), so it stays cleanly extractable into a standalone package later. - `dpdm` circular-dependency check now walks editor + portal + shared (the old glob matched only 2 files). - New **devDependencies only** — Storybook (+ a11y/docs/themes addons), MSW. No runtime dependencies added. - New tasks: `frontend:dev:portal`, `frontend:build:portal`. ## Testing done locally - `tsc` for both `portal` and `shared` projects — clean - `eslint --max-warnings=0` across the whole frontend — clean - `dpdm` circular-dependency check — no cycles - Editor builds clean: `vite build editor --mode core` (✓ built, only the pre-existing >500 kB chunk-size advisory) - Editor runs in dev (core mode) with **zero console errors**; portal runs in dev across all three tiers ## Notes for reviewers - The change is overwhelmingly **additive**: `shared/` and `portal/` are brand-new; the existing editor is path-reference changes only. - The portal is intentionally **mock-driven** at this stage — real backends and the remaining views land in follow-up phases. --- ## Checklist ### General - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### Translations (if applicable) - [ ] I ran [`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have run `task check` to verify linters, typechecks, and tests pass - [x] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#7-testing) for more details. --------- Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
This commit is contained in:
Reece Browne
co-authored by
Claude Opus 4.8
Claude Opus 4.8
parent
b355ccec9e
commit
919f0ade99
@@ -0,0 +1,262 @@
|
||||
import type { Meta, StoryObj } from "@storybook/react";
|
||||
|
||||
const meta: Meta = {
|
||||
title: "Foundations/Design Tokens",
|
||||
parameters: { layout: "padded" },
|
||||
};
|
||||
export default meta;
|
||||
type Story = StoryObj;
|
||||
|
||||
interface Swatch {
|
||||
label: string;
|
||||
varName: string;
|
||||
}
|
||||
|
||||
function Group({ heading, swatches }: { heading: string; swatches: Swatch[] }) {
|
||||
return (
|
||||
<div style={{ marginBottom: 28 }}>
|
||||
<h3
|
||||
style={{
|
||||
fontSize: 11,
|
||||
fontWeight: 600,
|
||||
textTransform: "uppercase",
|
||||
letterSpacing: 0.6,
|
||||
color: "var(--color-section-label)",
|
||||
margin: "0 0 0.625rem",
|
||||
}}
|
||||
>
|
||||
{heading}
|
||||
</h3>
|
||||
<div
|
||||
style={{
|
||||
display: "grid",
|
||||
gridTemplateColumns: "repeat(auto-fill, minmax(11.25rem, 1fr))",
|
||||
gap: 10,
|
||||
}}
|
||||
>
|
||||
{swatches.map((s) => (
|
||||
<div
|
||||
key={s.varName}
|
||||
style={{
|
||||
display: "flex",
|
||||
alignItems: "center",
|
||||
gap: 10,
|
||||
padding: 10,
|
||||
background: "var(--color-surface)",
|
||||
border: "1px solid var(--color-border)",
|
||||
borderRadius: "var(--radius-md)",
|
||||
}}
|
||||
>
|
||||
<div
|
||||
style={{
|
||||
width: 36,
|
||||
height: 36,
|
||||
borderRadius: 6,
|
||||
background: `var(${s.varName})`,
|
||||
border: "1px solid var(--color-border)",
|
||||
flexShrink: 0,
|
||||
}}
|
||||
/>
|
||||
<div style={{ minWidth: 0 }}>
|
||||
<div
|
||||
style={{
|
||||
fontSize: 12,
|
||||
fontWeight: 500,
|
||||
color: "var(--color-text-2)",
|
||||
}}
|
||||
>
|
||||
{s.label}
|
||||
</div>
|
||||
<div
|
||||
style={{
|
||||
fontSize: 11,
|
||||
fontFamily: "var(--font-mono)",
|
||||
color: "var(--color-text-4)",
|
||||
overflow: "hidden",
|
||||
textOverflow: "ellipsis",
|
||||
}}
|
||||
>
|
||||
{s.varName}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export const Colours: Story = {
|
||||
render: () => (
|
||||
<div>
|
||||
<Group
|
||||
heading="Brand & status"
|
||||
swatches={[
|
||||
{ label: "Blue", varName: "--color-blue" },
|
||||
{ label: "Blue dark", varName: "--color-blue-dark" },
|
||||
{ label: "Purple", varName: "--color-purple" },
|
||||
{ label: "Green", varName: "--color-green" },
|
||||
{ label: "Amber", varName: "--color-amber" },
|
||||
{ label: "Red", varName: "--color-red" },
|
||||
]}
|
||||
/>
|
||||
<Group
|
||||
heading="Category accents (theme-stable)"
|
||||
swatches={[
|
||||
{ label: "Insurance", varName: "--color-cat-insurance" },
|
||||
{ label: "Compliance", varName: "--color-cat-compliance" },
|
||||
{ label: "Finance", varName: "--color-cat-finance" },
|
||||
{ label: "Legal", varName: "--color-cat-legal" },
|
||||
{ label: "Healthcare", varName: "--color-cat-healthcare" },
|
||||
{ label: "Government", varName: "--color-cat-government" },
|
||||
{ label: "Operations", varName: "--color-cat-operations" },
|
||||
{ label: "HR", varName: "--color-cat-hr" },
|
||||
{ label: "Real estate", varName: "--color-cat-realestate" },
|
||||
{ label: "Energy", varName: "--color-cat-energy" },
|
||||
]}
|
||||
/>
|
||||
<Group
|
||||
heading="Surfaces"
|
||||
swatches={[
|
||||
{ label: "bg", varName: "--color-bg" },
|
||||
{ label: "surface", varName: "--color-surface" },
|
||||
{ label: "surface alt", varName: "--color-surface-alt" },
|
||||
{ label: "bg subtle", varName: "--color-bg-subtle" },
|
||||
{ label: "bg hover", varName: "--color-bg-hover" },
|
||||
{ label: "bg muted", varName: "--color-bg-muted" },
|
||||
{ label: "bg code", varName: "--color-bg-code" },
|
||||
{ label: "border", varName: "--color-border" },
|
||||
]}
|
||||
/>
|
||||
<Group
|
||||
heading="Code palette (always dark)"
|
||||
swatches={[
|
||||
{ label: "bg", varName: "--code-bg" },
|
||||
{ label: "text", varName: "--code-text" },
|
||||
{ label: "keyword", varName: "--code-keyword" },
|
||||
{ label: "string", varName: "--code-string" },
|
||||
{ label: "number", varName: "--code-number" },
|
||||
{ label: "fn", varName: "--code-fn" },
|
||||
{ label: "type", varName: "--code-type" },
|
||||
{ label: "property", varName: "--code-property" },
|
||||
]}
|
||||
/>
|
||||
</div>
|
||||
),
|
||||
};
|
||||
|
||||
export const Typography: Story = {
|
||||
render: () => (
|
||||
<div
|
||||
style={{
|
||||
display: "flex",
|
||||
flexDirection: "column",
|
||||
gap: 18,
|
||||
color: "var(--color-text-1)",
|
||||
}}
|
||||
>
|
||||
<div>
|
||||
<div
|
||||
style={{
|
||||
fontSize: 11,
|
||||
color: "var(--color-text-5)",
|
||||
marginBottom: 4,
|
||||
}}
|
||||
>
|
||||
Brand wordmark (Alumni Sans)
|
||||
</div>
|
||||
<span
|
||||
style={{
|
||||
fontFamily: "var(--font-brand)",
|
||||
fontSize: 32,
|
||||
fontWeight: 700,
|
||||
}}
|
||||
>
|
||||
Stirling
|
||||
</span>
|
||||
</div>
|
||||
<div>
|
||||
<div
|
||||
style={{
|
||||
fontSize: 11,
|
||||
color: "var(--color-text-5)",
|
||||
marginBottom: 4,
|
||||
}}
|
||||
>
|
||||
Page title (24/700)
|
||||
</div>
|
||||
<span style={{ fontSize: 24, fontWeight: 700 }}>Pipelines</span>
|
||||
</div>
|
||||
<div>
|
||||
<div
|
||||
style={{
|
||||
fontSize: 11,
|
||||
color: "var(--color-text-5)",
|
||||
marginBottom: 4,
|
||||
}}
|
||||
>
|
||||
Section title (13/600)
|
||||
</div>
|
||||
<span style={{ fontSize: 13, fontWeight: 600 }}>
|
||||
Configured primitives
|
||||
</span>
|
||||
</div>
|
||||
<div>
|
||||
<div
|
||||
style={{
|
||||
fontSize: 11,
|
||||
color: "var(--color-text-5)",
|
||||
marginBottom: 4,
|
||||
}}
|
||||
>
|
||||
Body (13/400)
|
||||
</div>
|
||||
<span style={{ fontSize: 13 }}>
|
||||
Drop a sample to see what just this op produces.
|
||||
</span>
|
||||
</div>
|
||||
<div>
|
||||
<div
|
||||
style={{
|
||||
fontSize: 11,
|
||||
color: "var(--color-text-5)",
|
||||
marginBottom: 4,
|
||||
}}
|
||||
>
|
||||
Code (12 mono)
|
||||
</div>
|
||||
<span style={{ fontFamily: "var(--font-mono)", fontSize: 12 }}>
|
||||
POST /v1/coi
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
),
|
||||
};
|
||||
|
||||
export const Motion: Story = {
|
||||
render: () => (
|
||||
<div style={{ display: "flex", flexDirection: "column", gap: 18 }}>
|
||||
<div
|
||||
style={{
|
||||
background: "var(--color-surface)",
|
||||
border: "1px solid var(--color-border)",
|
||||
padding: 16,
|
||||
borderRadius: 8,
|
||||
animation: "fadeInUp 0.25s cubic-bezier(0.4, 0, 0.2, 1) both",
|
||||
}}
|
||||
>
|
||||
fadeInUp — standard view transition
|
||||
</div>
|
||||
<div
|
||||
style={{
|
||||
display: "inline-block",
|
||||
width: 12,
|
||||
height: 12,
|
||||
borderRadius: 6,
|
||||
background: "var(--color-green)",
|
||||
animation: "pulse 2s ease-in-out infinite",
|
||||
}}
|
||||
/>
|
||||
</div>
|
||||
),
|
||||
};
|
||||
Reference in New Issue
Block a user