@builderos/create-agent-os 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -0
- package/bin/cli.js +133 -0
- package/package.json +40 -0
- package/src/template/App.tsx +68 -0
- package/src/template/agent-os/commands/create-tasks/1-get-spec-requirements.md +19 -0
- package/src/template/agent-os/commands/create-tasks/2-create-tasks-list.md +234 -0
- package/src/template/agent-os/commands/create-tasks/create-tasks.md +254 -0
- package/src/template/agent-os/commands/design-screen/design-screen.md +32 -0
- package/src/template/agent-os/commands/design-shell/design-shell.md +34 -0
- package/src/template/agent-os/commands/design-tokens/design-tokens.md +36 -0
- package/src/template/agent-os/commands/export-product/export-product.md +44 -0
- package/src/template/agent-os/commands/implement-tasks/1-determine-tasks.md +13 -0
- package/src/template/agent-os/commands/implement-tasks/2-implement-tasks.md +63 -0
- package/src/template/agent-os/commands/implement-tasks/3-verify-implementation.md +113 -0
- package/src/template/agent-os/commands/implement-tasks/implement-tasks.md +207 -0
- package/src/template/agent-os/commands/initialize-design/initialize-design.md +54 -0
- package/src/template/agent-os/commands/orchestrate-tasks/orchestrate-tasks.md +180 -0
- package/src/template/agent-os/commands/plan-product/1-product-concept.md +53 -0
- package/src/template/agent-os/commands/plan-product/2-create-mission.md +78 -0
- package/src/template/agent-os/commands/plan-product/3-create-roadmap.md +73 -0
- package/src/template/agent-os/commands/plan-product/4-create-tech-stack.md +46 -0
- package/src/template/agent-os/commands/plan-product/plan-product.md +241 -0
- package/src/template/agent-os/commands/sample-data/sample-data.md +51 -0
- package/src/template/agent-os/commands/scaffold-implementation/scaffold-implementation.md +36 -0
- package/src/template/agent-os/commands/screenshot-design/screenshot-design.md +21 -0
- package/src/template/agent-os/commands/shape-spec/1-initialize-spec.md +95 -0
- package/src/template/agent-os/commands/shape-spec/2-shape-spec.md +300 -0
- package/src/template/agent-os/commands/shape-spec/shape-spec.md +40 -0
- package/src/template/agent-os/commands/write-spec/write-spec.md +134 -0
- package/src/template/agent-os/config.yml +13 -0
- package/src/template/agent-os/product/mission.md +29 -0
- package/src/template/agent-os/product/roadmap.md +9 -0
- package/src/template/agent-os/product/tech-stack.md +14 -0
- package/src/template/agent-os/specs/README.md +1 -0
- package/src/template/agent-os/standards/backend/api.md +10 -0
- package/src/template/agent-os/standards/backend/migrations.md +9 -0
- package/src/template/agent-os/standards/backend/models.md +10 -0
- package/src/template/agent-os/standards/backend/queries.md +9 -0
- package/src/template/agent-os/standards/frontend/accessibility.md +10 -0
- package/src/template/agent-os/standards/frontend/components.md +11 -0
- package/src/template/agent-os/standards/frontend/css.md +7 -0
- package/src/template/agent-os/standards/frontend/responsive.md +11 -0
- package/src/template/agent-os/standards/global/coding-style.md +10 -0
- package/src/template/agent-os/standards/global/commenting.md +5 -0
- package/src/template/agent-os/standards/global/conventions.md +11 -0
- package/src/template/agent-os/standards/global/error-handling.md +9 -0
- package/src/template/agent-os/standards/global/tech-stack.md +31 -0
- package/src/template/agent-os/standards/global/validation.md +11 -0
- package/src/template/agent-os/standards/testing/test-writing.md +9 -0
- package/src/template/agent-os-ui/README.md +73 -0
- package/src/template/agent-os-ui/package-lock.json +5028 -0
- package/src/template/agent-os-ui/package.json +52 -0
- package/src/template/agent-os-ui/postcss.config.js +6 -0
- package/src/template/agent-os-ui/src/components/AgentShell.tsx +31 -0
- package/src/template/agent-os-ui/src/components/AgentSidebar.tsx +65 -0
- package/src/template/agent-os-ui/src/components/GuidanceCard.tsx +75 -0
- package/src/template/agent-os-ui/src/components/MarkdownViewer.tsx +25 -0
- package/src/template/agent-os-ui/src/components/PromptButton.tsx +28 -0
- package/src/template/agent-os-ui/src/components/StatusItem.tsx +45 -0
- package/src/template/agent-os-ui/src/components/ThemeToggle.tsx +72 -0
- package/src/template/agent-os-ui/src/index.ts +11 -0
- package/src/template/agent-os-ui/src/style.css +3 -0
- package/src/template/agent-os-ui/tailwind.config.js +50 -0
- package/src/template/agent-os-ui/tsconfig.json +33 -0
- package/src/template/agent-os-ui/vite.config.ts +32 -0
- package/src/template/control-center/backend/backend.log +2 -0
- package/src/template/control-center/backend/index.js +228 -0
- package/src/template/control-center/backend/package-lock.json +951 -0
- package/src/template/control-center/backend/package.json +19 -0
- package/src/template/control-center/frontend/README.md +73 -0
- package/src/template/control-center/frontend/eslint.config.js +23 -0
- package/src/template/control-center/frontend/index.html +21 -0
- package/src/template/control-center/frontend/package-lock.json +5752 -0
- package/src/template/control-center/frontend/package.json +42 -0
- package/src/template/control-center/frontend/public/runtime-config.json +11 -0
- package/src/template/control-center/frontend/public/vite.svg +1 -0
- package/src/template/control-center/frontend/src/App.css +42 -0
- package/src/template/control-center/frontend/src/App.tsx +738 -0
- package/src/template/control-center/frontend/src/assets/react.svg +1 -0
- package/src/template/control-center/frontend/src/components/ThemeToggle.tsx +64 -0
- package/src/template/control-center/frontend/src/components/ui/ToastContext.tsx +81 -0
- package/src/template/control-center/frontend/src/index.css +194 -0
- package/src/template/control-center/frontend/src/main.tsx +14 -0
- package/src/template/control-center/frontend/src/vite-env.d.ts +1 -0
- package/src/template/control-center/frontend/tsconfig.app.json +28 -0
- package/src/template/control-center/frontend/tsconfig.json +7 -0
- package/src/template/control-center/frontend/tsconfig.node.json +26 -0
- package/src/template/control-center/frontend/vite.config.ts +22 -0
- package/src/template/design/.claude/commands/design-os/data-model.md +122 -0
- package/src/template/design/.claude/commands/design-os/design-screen.md +309 -0
- package/src/template/design/.claude/commands/design-os/design-shell.md +238 -0
- package/src/template/design/.claude/commands/design-os/design-tokens.md +166 -0
- package/src/template/design/.claude/commands/design-os/export-product.md +1105 -0
- package/src/template/design/.claude/commands/design-os/product-roadmap.md +121 -0
- package/src/template/design/.claude/commands/design-os/product-vision.md +99 -0
- package/src/template/design/.claude/commands/design-os/sample-data.md +263 -0
- package/src/template/design/.claude/commands/design-os/screenshot-design.md +112 -0
- package/src/template/design/.claude/commands/design-os/shape-section.md +138 -0
- package/src/template/design/.claude/skills/frontend-design/SKILL.md +42 -0
- package/src/template/design/.github/CODE_OF_CONDUCT.md +5 -0
- package/src/template/design/.github/CONTRIBUTING.md +51 -0
- package/src/template/design/.github/ISSUE_TEMPLATE/config.yml +22 -0
- package/src/template/design/.github/PULL_REQUEST_TEMPLATE.md +20 -0
- package/src/template/design/.github/SECURITY.yml +5 -0
- package/src/template/design/.github/SUPPORT.md +19 -0
- package/src/template/design/.github/workflows/pr-decline.yml +135 -0
- package/src/template/design/.github/workflows/stale.yml +25 -0
- package/src/template/design/CHANGELOG.md +13 -0
- package/src/template/design/LICENSE +21 -0
- package/src/template/design/README.md +54 -0
- package/src/template/design/agents.md +218 -0
- package/src/template/design/claude.md +1 -0
- package/src/template/design/components.json +22 -0
- package/src/template/design/docs/codebase-implementation.md +153 -0
- package/src/template/design/docs/design-section.md +135 -0
- package/src/template/design/docs/export.md +149 -0
- package/src/template/design/docs/getting-started.md +59 -0
- package/src/template/design/docs/index.md +56 -0
- package/src/template/design/docs/product-planning.md +113 -0
- package/src/template/design/docs/requirements.md +22 -0
- package/src/template/design/docs/usage.md +62 -0
- package/src/template/design/eslint.config.js +23 -0
- package/src/template/design/index.html +21 -0
- package/src/template/design/package-lock.json +5473 -0
- package/src/template/design/package.json +47 -0
- package/src/template/design/product-plan.zip +0 -0
- package/src/template/design/public/vite.svg +1 -0
- package/src/template/design/src/assets/react.svg +1 -0
- package/src/template/design/src/components/AppLayout.tsx +95 -0
- package/src/template/design/src/components/DataCard.tsx +139 -0
- package/src/template/design/src/components/DataModelPage.tsx +120 -0
- package/src/template/design/src/components/DesignPage.tsx +284 -0
- package/src/template/design/src/components/EmptyState.tsx +155 -0
- package/src/template/design/src/components/ExportPage.tsx +344 -0
- package/src/template/design/src/components/NextPhaseButton.tsx +33 -0
- package/src/template/design/src/components/PhaseNav.tsx +152 -0
- package/src/template/design/src/components/PhaseWarningBanner.tsx +81 -0
- package/src/template/design/src/components/ProductOverviewCard.tsx +102 -0
- package/src/template/design/src/components/ProductPage.tsx +97 -0
- package/src/template/design/src/components/ScreenDesignPage.tsx +370 -0
- package/src/template/design/src/components/ScreenDesignsCard.tsx +49 -0
- package/src/template/design/src/components/SectionPage.tsx +256 -0
- package/src/template/design/src/components/SectionsCard.tsx +47 -0
- package/src/template/design/src/components/SectionsPage.tsx +181 -0
- package/src/template/design/src/components/ShellCard.tsx +85 -0
- package/src/template/design/src/components/ShellDesignPage.tsx +242 -0
- package/src/template/design/src/components/SpecCard.tsx +121 -0
- package/src/template/design/src/components/StepIndicator.tsx +75 -0
- package/src/template/design/src/components/ThemeToggle.tsx +86 -0
- package/src/template/design/src/components/ui/ToastContext.tsx +81 -0
- package/src/template/design/src/components/ui/avatar.tsx +53 -0
- package/src/template/design/src/components/ui/badge.tsx +46 -0
- package/src/template/design/src/components/ui/button.tsx +60 -0
- package/src/template/design/src/components/ui/card.tsx +92 -0
- package/src/template/design/src/components/ui/collapsible.tsx +48 -0
- package/src/template/design/src/components/ui/dialog.tsx +143 -0
- package/src/template/design/src/components/ui/dropdown-menu.tsx +255 -0
- package/src/template/design/src/components/ui/input.tsx +21 -0
- package/src/template/design/src/components/ui/label.tsx +22 -0
- package/src/template/design/src/components/ui/progress.tsx +24 -0
- package/src/template/design/src/components/ui/scroll-area.tsx +18 -0
- package/src/template/design/src/components/ui/select.tsx +67 -0
- package/src/template/design/src/components/ui/separator.tsx +28 -0
- package/src/template/design/src/components/ui/sheet.tsx +137 -0
- package/src/template/design/src/components/ui/skeleton.tsx +13 -0
- package/src/template/design/src/components/ui/switch.tsx +46 -0
- package/src/template/design/src/components/ui/table.tsx +116 -0
- package/src/template/design/src/components/ui/tabs.tsx +64 -0
- package/src/template/design/src/index.css +284 -0
- package/src/template/design/src/lib/data-model-loader.ts +91 -0
- package/src/template/design/src/lib/design-system-loader.ts +101 -0
- package/src/template/design/src/lib/product-loader.ts +221 -0
- package/src/template/design/src/lib/router.tsx +52 -0
- package/src/template/design/src/lib/section-loader.ts +272 -0
- package/src/template/design/src/lib/shell-loader.ts +175 -0
- package/src/template/design/src/lib/utils.ts +6 -0
- package/src/template/design/src/main.tsx +15 -0
- package/src/template/design/src/sections/.gitkeep +0 -0
- package/src/template/design/src/sections/ai-orchestration-engine-oai/OrchestrationEngine.tsx +348 -0
- package/src/template/design/src/sections/core-platform-shell/AppShell.tsx +403 -0
- package/src/template/design/src/sections/gemini-live-integration/GeminiIntegration.tsx +332 -0
- package/src/template/design/src/sections/interactive-2d-canvas/WhiteboardCanvas.tsx +334 -0
- package/src/template/design/src/sections/participation-equity-tracker/EquityTracker.tsx +383 -0
- package/src/template/design/src/sections/persistent-memory-system/PersistentMemory.tsx +308 -0
- package/src/template/design/src/sections/real-time-communication-layer/VideoSession.tsx +342 -0
- package/src/template/design/src/sections/visual-intelligence-agents/VisualAgents.tsx +311 -0
- package/src/template/design/src/types/product.ts +97 -0
- package/src/template/design/src/types/section.ts +33 -0
- package/src/template/design/tsconfig.app.json +34 -0
- package/src/template/design/tsconfig.json +13 -0
- package/src/template/design/tsconfig.node.json +26 -0
- package/src/template/design/vite.config.ts +18 -0
- package/src/template/package.json +27 -0
- package/src/template/vite.config.ts +16 -0
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Getting Started
|
|
2
|
+
|
|
3
|
+
## Clone the Repository
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
git clone https://github.com/buildermethods/design-os.git my-project-design
|
|
7
|
+
cd my-project-design
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
Replace `my-project-design` with whatever you want to name your design workspace.
|
|
11
|
+
|
|
12
|
+
## Remove the Original Remote
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
git remote remove origin
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Now you have a clean local instance ready to use.
|
|
19
|
+
|
|
20
|
+
## Install Dependencies
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Start the Dev Server
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npm run dev
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Open [http://localhost:5173](http://localhost:5173) in your browser.
|
|
33
|
+
|
|
34
|
+
## Open Claude Code
|
|
35
|
+
|
|
36
|
+
In the same project directory, start Claude Code:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
claude
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
You're ready to start designing. Run `/product-vision` to begin defining your product.
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Optional: Save as Your Own Template
|
|
47
|
+
|
|
48
|
+
If you want to reuse Design OS for future projects:
|
|
49
|
+
|
|
50
|
+
1. Push to your own GitHub repository:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
git remote add origin https://github.com/YOUR_USERNAME/YOUR_REPO_NAME.git
|
|
54
|
+
git push -u origin main
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
2. Go to your repository on GitHub, click **Settings**, and check **Template repository**.
|
|
58
|
+
|
|
59
|
+
Now you can create new instances using GitHub's "Use this template" button.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# What is Design OS?
|
|
2
|
+
|
|
3
|
+
Design OS is the missing step between your product idea and your codebase.
|
|
4
|
+
|
|
5
|
+
It's a product planning and design tool that helps you define your product vision, structure your data model, design your UI, and export production-ready components for implementation. Rather than jumping straight into code, you work through a guided process that captures what you're building and why—then hands off everything your coding agent needs to build it right.
|
|
6
|
+
|
|
7
|
+
## The Problem
|
|
8
|
+
|
|
9
|
+
AI coding tools are incredible at building fast. But the results often miss the mark. You describe what you want, the agent builds *something*, but it's not what you envisioned. The UI looks generic. Features get half-implemented. You spend as much time fixing and redirecting as you would have spent building.
|
|
10
|
+
|
|
11
|
+
The core issue: we're asking coding agents to figure out what to build *and* build it simultaneously. Design decisions get made on the fly, buried in code, impossible to adjust without starting over. There's no spec. No shared understanding. No source of truth for what "done" looks like.
|
|
12
|
+
|
|
13
|
+
## The Design OS Process
|
|
14
|
+
|
|
15
|
+
Design OS powers a guided design and architecture process. You + AI, working together through structured steps:
|
|
16
|
+
|
|
17
|
+
1. **Product Planning** — Define your vision, break down your roadmap, and model your data
|
|
18
|
+
2. **Design System** — Choose colors, typography, and design your application shell
|
|
19
|
+
3. **Section Design** — For each feature area: specify requirements, generate sample data, and design the screens
|
|
20
|
+
4. **Export** — Generate a complete handoff package for implementation
|
|
21
|
+
|
|
22
|
+
Each step is a conversation. The AI asks questions, you provide direction, and together you shape a product that matches your vision—before any implementation begins.
|
|
23
|
+
|
|
24
|
+
## How It Works
|
|
25
|
+
|
|
26
|
+
Design OS is its own separate codebase—a design environment you use *before* building. When you're done, you export components and assets to import into your actual product's codebase.
|
|
27
|
+
|
|
28
|
+
You interact with Design OS through slash commands. Each command walks you through a specific part of the process:
|
|
29
|
+
|
|
30
|
+
- `/product-vision` — Define what you're building and why
|
|
31
|
+
- `/product-roadmap` — Break your product into buildable sections
|
|
32
|
+
- `/data-model` — Define the core entities in your system
|
|
33
|
+
- `/design-tokens` — Choose your color palette and typography
|
|
34
|
+
- `/design-shell` — Design navigation and layout
|
|
35
|
+
- `/shape-section` — Specify a section's scope and requirements
|
|
36
|
+
- `/sample-data` — Generate realistic data for screen designs
|
|
37
|
+
- `/design-screen` — Create production-ready React components
|
|
38
|
+
- `/screenahot-design` — Snap a screenshot of a finished design screen for quick reference
|
|
39
|
+
- `/export-product` — Generate the complete handoff package
|
|
40
|
+
|
|
41
|
+
See [Usage](usage.md) for the full workflow.
|
|
42
|
+
|
|
43
|
+
## Who It's For
|
|
44
|
+
|
|
45
|
+
- **Technical builders** — Full control over architecture and design decisions without doing all the legwork yourself.
|
|
46
|
+
- **Non-technical product builders** — A strong vision for how your product should work, plus the ability to put your imprint on its systems—no technical background required.
|
|
47
|
+
|
|
48
|
+
## Compatibility
|
|
49
|
+
|
|
50
|
+
- Works with any AI coding agent: Claude Code, Cursor, Copilot, or anything that can implement from a handoff
|
|
51
|
+
- Your frontend needs React and Tailwind CSS
|
|
52
|
+
- Your backend can be anything—Rails, Laravel, Next.js, Python, whatever
|
|
53
|
+
|
|
54
|
+
## Open Source
|
|
55
|
+
|
|
56
|
+
Design OS is free, open source, and runs locally.
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
# Product Planning
|
|
2
|
+
|
|
3
|
+
The first phase of Design OS establishes the foundation for your product. Complete these steps before designing any screens.
|
|
4
|
+
|
|
5
|
+
## 1. Product Vision
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
/product-vision
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Define your product's core identity. This is a conversational process where you'll establish:
|
|
12
|
+
|
|
13
|
+
- **Product name** — A clear, memorable name
|
|
14
|
+
- **Description** — 1-3 sentences capturing the essence
|
|
15
|
+
- **Problems & solutions** — What pain points you're addressing and how
|
|
16
|
+
- **Key features** — The main capabilities that make this possible
|
|
17
|
+
|
|
18
|
+
Share any notes, ideas, or rough thoughts you have about what you're building. The AI will ask clarifying questions and help you refine everything into a clear product overview.
|
|
19
|
+
|
|
20
|
+
**Creates:** `product/product-overview.md`
|
|
21
|
+
|
|
22
|
+
## 2. Product Roadmap
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
/product-roadmap
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Break your product into 3-5 sections. Each section represents:
|
|
29
|
+
|
|
30
|
+
- A navigation item in your app's UI
|
|
31
|
+
- A self-contained feature area that can be designed and built independently
|
|
32
|
+
- A logical phase of your development roadmap
|
|
33
|
+
|
|
34
|
+
Based on your product overview, the AI will propose sections and discuss ordering. Sections are sequenced by development priority—the first section is your core functionality, with each subsequent section building on it.
|
|
35
|
+
|
|
36
|
+
**Creates:** `product/product-roadmap.md`
|
|
37
|
+
|
|
38
|
+
## 3. Data Model
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
/data-model
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Define the core entities in your product—the "nouns" of your system. What are the main things users create, view, and manage?
|
|
45
|
+
|
|
46
|
+
The focus is conceptual, not technical:
|
|
47
|
+
|
|
48
|
+
- **Entity names** — User, Project, Invoice, Task, etc.
|
|
49
|
+
- **Plain-language descriptions** — What each entity represents
|
|
50
|
+
- **Relationships** — How entities connect to each other
|
|
51
|
+
|
|
52
|
+
Don't worry about database schemas or field types. Keep it minimal. The implementation agent will extend the model with additional details as needed.
|
|
53
|
+
|
|
54
|
+
**Creates:** `product/data-model/data-model.md`
|
|
55
|
+
|
|
56
|
+
## 4. Design Tokens
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
/design-tokens
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Choose your visual identity:
|
|
63
|
+
|
|
64
|
+
### Colors
|
|
65
|
+
|
|
66
|
+
Select from Tailwind's built-in color palette:
|
|
67
|
+
|
|
68
|
+
- **Primary** — Main accent for buttons, links, key actions (e.g., `blue`, `indigo`, `emerald`, `lime`)
|
|
69
|
+
- **Secondary** — Complementary accent for tags, highlights (e.g., `violet`, `amber`, `teal`)
|
|
70
|
+
- **Neutral** — Backgrounds, text, borders (e.g., `slate`, `gray`, `zinc`, `stone`)
|
|
71
|
+
|
|
72
|
+
### Typography
|
|
73
|
+
|
|
74
|
+
Select from Google Fonts:
|
|
75
|
+
|
|
76
|
+
- **Heading** — For titles and section headers (e.g., `DM Sans`, `Inter`, `Space Grotesk`)
|
|
77
|
+
- **Body** — For paragraphs and UI text (e.g., `Inter`, `Source Sans 3`, `Nunito Sans`)
|
|
78
|
+
- **Mono** — For code and technical content (e.g., `JetBrains Mono`, `Fira Code`)
|
|
79
|
+
|
|
80
|
+
The AI will suggest options based on your product type and help you find a combination that fits.
|
|
81
|
+
|
|
82
|
+
**Creates:** `product/design-system/colors.json`, `product/design-system/typography.json`
|
|
83
|
+
|
|
84
|
+
## 5. Application Shell
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
/design-shell
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Design the persistent navigation and layout that wraps all your sections. Choose from common patterns:
|
|
91
|
+
|
|
92
|
+
- **Sidebar Navigation** — Vertical nav on the left, content on the right. Best for dashboard-style tools, admin panels, apps with many sections.
|
|
93
|
+
- **Top Navigation** — Horizontal nav at top, content below. Best for simpler apps, marketing-style products, fewer sections.
|
|
94
|
+
- **Minimal Header** — Just logo + user menu. Best for single-purpose tools, wizard-style flows.
|
|
95
|
+
|
|
96
|
+
You'll also define:
|
|
97
|
+
|
|
98
|
+
- User menu placement and contents
|
|
99
|
+
- Responsive behavior (how it adapts on mobile)
|
|
100
|
+
- Any additional nav items (Settings, Help, etc.)
|
|
101
|
+
|
|
102
|
+
The shell is implemented as React components that will wrap your section screen designs.
|
|
103
|
+
|
|
104
|
+
**Creates:**
|
|
105
|
+
- `product/shell/spec.md` — Shell specification
|
|
106
|
+
- `src/shell/components/AppShell.tsx` — Main shell wrapper
|
|
107
|
+
- `src/shell/components/MainNav.tsx` — Navigation component
|
|
108
|
+
- `src/shell/components/UserMenu.tsx` — User menu component
|
|
109
|
+
- `src/shell/ShellPreview.tsx` — Preview wrapper for Design OS
|
|
110
|
+
|
|
111
|
+
## What's Next
|
|
112
|
+
|
|
113
|
+
With the foundation established, you're ready to design individual sections. See [Designing Sections](design-section.md) for the next steps.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Requirements
|
|
2
|
+
|
|
3
|
+
## Running Design OS
|
|
4
|
+
|
|
5
|
+
Design OS runs locally on your machine. You'll need:
|
|
6
|
+
|
|
7
|
+
- **Node.js** (v18 or higher)
|
|
8
|
+
- **npm** (comes with Node.js)
|
|
9
|
+
- **An AI coding assistant** — Design OS uses slash commands to guide the design process. Claude Code is recommended, but you can invoke the Design OS commands from any AI coding tool that supports custom commands or prompts (Cursor, Windsurf, Codex, etc.)
|
|
10
|
+
|
|
11
|
+
## Installing Your Exported Components
|
|
12
|
+
|
|
13
|
+
When you export your designs, you get production-ready React components. Your target codebase needs:
|
|
14
|
+
|
|
15
|
+
### Required
|
|
16
|
+
|
|
17
|
+
- **React** (v18 or higher)
|
|
18
|
+
- **Tailwind CSS** (v4) — Components use Tailwind utility classes for styling
|
|
19
|
+
|
|
20
|
+
### Backend
|
|
21
|
+
|
|
22
|
+
Your backend can be anything—Rails, Laravel, Next.js API routes, Python, Go, whatever. Design OS only handles the frontend design layer.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Usage
|
|
2
|
+
|
|
3
|
+
Design OS uses slash commands to guide you through the design process. Each command is a conversation—the AI asks questions, you provide direction, and together you shape your product.
|
|
4
|
+
|
|
5
|
+
## The Design Workflow
|
|
6
|
+
|
|
7
|
+
Design OS follows a structured sequence. Each step builds on the previous one.
|
|
8
|
+
|
|
9
|
+
### Phase 1: Product Planning
|
|
10
|
+
|
|
11
|
+
Before designing any screens, establish the foundation:
|
|
12
|
+
|
|
13
|
+
1. **Product Vision** — Define what you're building and why
|
|
14
|
+
2. **Product Roadmap** — Break your product into sections
|
|
15
|
+
3. **Data Model** — Define the core entities in your system
|
|
16
|
+
4. **Design Tokens** — Choose colors and typography
|
|
17
|
+
5. **Application Shell** — Design navigation and layout
|
|
18
|
+
|
|
19
|
+
See [Product Planning](product-planning.md) for details on each command.
|
|
20
|
+
|
|
21
|
+
### Phase 2: Section Design
|
|
22
|
+
|
|
23
|
+
Once the foundation is set, work through each section:
|
|
24
|
+
|
|
25
|
+
1. **Shape the Section** — Define scope and requirements
|
|
26
|
+
2. **Create Sample Data** — Generate realistic data and types
|
|
27
|
+
3. **Design the Screen** — Build the actual React components
|
|
28
|
+
4. **Capture Screenshots** — Document the design (optional)
|
|
29
|
+
|
|
30
|
+
Repeat for each section in your roadmap.
|
|
31
|
+
|
|
32
|
+
See [Designing Sections](design-section.md) for details on each command.
|
|
33
|
+
|
|
34
|
+
### Phase 3: Export
|
|
35
|
+
|
|
36
|
+
When all sections are designed:
|
|
37
|
+
|
|
38
|
+
1. **Export** — Generate the complete handoff package
|
|
39
|
+
|
|
40
|
+
See [Export](export.md) for details on what's included and how to use it.
|
|
41
|
+
|
|
42
|
+
## Quick Reference
|
|
43
|
+
|
|
44
|
+
| Command | Purpose |
|
|
45
|
+
|---------|---------|
|
|
46
|
+
| `/product-vision` | Define product name, description, problems, features |
|
|
47
|
+
| `/product-roadmap` | Break product into sections |
|
|
48
|
+
| `/data-model` | Define core entities and relationships |
|
|
49
|
+
| `/design-tokens` | Choose colors and typography |
|
|
50
|
+
| `/design-shell` | Design navigation and layout |
|
|
51
|
+
| `/shape-section` | Define a section's scope and requirements |
|
|
52
|
+
| `/sample-data` | Generate sample data and TypeScript types |
|
|
53
|
+
| `/design-screen` | Create screen design components |
|
|
54
|
+
| `/screenshot-design` | Capture screenshots |
|
|
55
|
+
| `/export-product` | Generate the complete handoff package |
|
|
56
|
+
|
|
57
|
+
## Tips
|
|
58
|
+
|
|
59
|
+
- **Follow the sequence** — Each step builds on the previous. Don't skip ahead.
|
|
60
|
+
- **Be specific** — The more detail you provide, the better the output.
|
|
61
|
+
- **Iterate** — Each command is a conversation. Refine until you're happy.
|
|
62
|
+
- **Restart the dev server** — After creating new components, restart to see changes.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import js from '@eslint/js'
|
|
2
|
+
import globals from 'globals'
|
|
3
|
+
import reactHooks from 'eslint-plugin-react-hooks'
|
|
4
|
+
import reactRefresh from 'eslint-plugin-react-refresh'
|
|
5
|
+
import tseslint from 'typescript-eslint'
|
|
6
|
+
import { defineConfig, globalIgnores } from 'eslint/config'
|
|
7
|
+
|
|
8
|
+
export default defineConfig([
|
|
9
|
+
globalIgnores(['dist']),
|
|
10
|
+
{
|
|
11
|
+
files: ['**/*.{ts,tsx}'],
|
|
12
|
+
extends: [
|
|
13
|
+
js.configs.recommended,
|
|
14
|
+
tseslint.configs.recommended,
|
|
15
|
+
reactHooks.configs.flat.recommended,
|
|
16
|
+
reactRefresh.configs.vite,
|
|
17
|
+
],
|
|
18
|
+
languageOptions: {
|
|
19
|
+
ecmaVersion: 2020,
|
|
20
|
+
globals: globals.browser,
|
|
21
|
+
},
|
|
22
|
+
},
|
|
23
|
+
])
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8" />
|
|
6
|
+
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
|
|
7
|
+
<link rel="preconnect" href="https://fonts.googleapis.com">
|
|
8
|
+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
9
|
+
<link
|
|
10
|
+
href="https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,300;0,9..40,400;0,9..40,500;0,9..40,600;0,9..40,700;1,9..40,400&family=IBM+Plex+Mono:wght@400;500&display=swap"
|
|
11
|
+
rel="stylesheet">
|
|
12
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
13
|
+
<title>Design OS</title>
|
|
14
|
+
</head>
|
|
15
|
+
|
|
16
|
+
<body>
|
|
17
|
+
<div id="root"></div>
|
|
18
|
+
<script type="module" src="/src/main.tsx"></script>
|
|
19
|
+
</body>
|
|
20
|
+
|
|
21
|
+
</html>
|