Skip to content

forge-ui/forge

Repository files navigation

Forge

面向 SaaS 后台和 ToB 业务系统的开源 React 组件库与模板工程。

Forge 把团队做后台产品时反复重建的东西整理成一套可直接使用的工程资产:设计 token、React 组件、AppLayout、数据密集型 UI、完整业务模板,以及一份给 AI coding agent 使用的 Forge Skill。

目标:让人和 AI 都能基于同一套组件规则,稳定地交付专业、统一、可维护的后台界面。

Forge dashboard builder preview

快速开始

太长不看版,直接粘给Codex,快速开始

展开完整提示词,一键复制给 Codex
请用 Forge 生态创建一个新的后台原型项目。

Forge 仓库地址:https://github.com/forge-ui/forge
Forge starter 地址:https://github.com/forge-ui/forge-starter

请先确认本地已经安装或可读取 Forge Skill 和 forge-app-design 插件;如果没有,请从 Forge 仓库安装或读取对应说明。
然后 clone Forge starter 并初始化环境。
请确认项目已经安装 @forge-ui-official/core;如果 starter 没有带上,请执行 pnpm add @forge-ui-official/core。
同时确认入口 CSS 已引入 @forge-ui-official/core/styles.css,并且 Tailwind v4 已配置 @source 指向 @forge-ui-official/core/dist。
最后确认 pnpm dev、pnpm typecheck、pnpm build 都可用。

环境就绪后,先主动向我确认业务目标、用户角色、需要的页面/模块、核心数据对象、主要操作流程和验收标准。
我确认后,再开始设计并实现业务模块。

实现时请使用 Forge Skill 和 forge-app-design 插件:
- Forge Skill 负责约束组件库、token、AppLayout 和基础样式。
- forge-app-design 负责把需求梳理成页面意图、信息架构、业务模块、组件计划和验收清单。

页面实现优先使用 AppLayout 和 ForgeUI 组件,不要手写基础 Button/Card/Table/Form/Layout 样式。
页面布局可以按业务需要设计,但基础颜色、字体、圆角、边框、密度和响应式行为必须遵循 ForgeUI。

完成后运行 pnpm typecheck 和 pnpm build,并给出可访问地址、页面截图和剩余问题。

新项目推荐直接从 starter 开始:

git clone https://github.com/forge-ui/forge-starter.git
cd forge-starter
pnpm install
pnpm dev

已有 Next.js / Tailwind v4 项目接入组件库:

pnpm add @forge-ui-official/core
pnpm add -D tailwindcss @tailwindcss/postcss

在入口 CSS 中加入:

@import "tailwindcss";
@import "@forge-ui-official/core/styles.css";
@source "../../node_modules/@forge-ui-official/core/dist";

然后直接使用组件:

import { AppLayout, Button, DataTable, SurfaceCard } from "@forge-ui-official/core";

更完整的 AI 约束和验收规则在 Forge Skill / forge-app-design 插件里。

你可以用它做什么

  • 搭后台产品:订单、商品、客户、项目、成员、文件、发票、详情页、新建页、编辑页等常见业务页面都有模板可参考。
  • 搭 SaaS 控制台:内置多套 dashboard 组合,覆盖电商、财务、项目管理、CRM、分析看板等场景。
  • 搭统一设计系统:组件、颜色、字体、圆角、阴影和交互状态统一由 @forge-ui-official/core 提供。
  • 让 AI 写得更稳:Forge Skill / forge-app-design 会约束 AI 优先使用组件、token、布局和模板,而不是临时手搓 UI。

核心能力

  • React 组件库:Button、Form、DataTable、Calendar、Chart、Card、Toolbar、Dialog、Tooltip、File、Avatar 等后台高频组件。
  • 应用级布局AppLayout 内置 sidebar、topbar、profile、notification、language switcher、team switcher 和 page header。
  • 业务模板:电商后台、项目管理后台、dashboard builder、登录流程、详情页、创建/编辑流程、发票页。
  • Tailwind v4 设计 token:通过 @forge-ui-official/core/styles.css 暴露 Forge 的颜色、排版和组件样式。
  • AI-ready 工作流:面向 Codex、Claude Code、Cursor 等工具的可安装 Skill。

仓库结构

路径 说明
core/ @forge-ui-official/core 组件库源码
src/app/docs 文档页面
src/app/components 组件展示与变体
src/app/cases 组件组合案例
src/app/templates 完整后台模板和业务页面
.agents/skills/forge Forge UI Kit skill,用于在本仓和 starter 中写业务页面
plugins/forge-app-design Codex 侧 Forge 原型设计插件、规则、样例、验收和 intake 资产
public/ 图片、图标和安装脚本

本地开发

pnpm install
pnpm dev

常用命令:

pnpm build           # 构建组件包和文档/示例站
pnpm typecheck       # 检查组件包和站点类型
pnpm core:build      # 只构建 @forge-ui-official/core
pnpm core:typecheck  # 只检查组件包类型
pnpm lint            # 运行 ESLint

Forge Skill

安装 Forge Skill 后,AI coding agent 会更倾向于复用 Forge 组件、token、布局和模板,减少临时拼 UI 带来的样式漂移。Codex 场景下,推荐同时使用 forge-app-design 插件作为 Product Design 到 Forge starter 的落地与验收层。

# Claude Code / Cursor
curl -fsSL https://forgeui.org/install-skill.sh | bash

# Codex
curl -fsSL https://forgeui.org/install-skill.sh | FORGE_AGENT=codex bash

如果官网域名暂时不可用,也可以直接从 GitHub 安装:

curl -fsSL https://raw.githubusercontent.com/forge-ui/forge/main/public/install-skill.sh | FORGE_AGENT=codex bash

Forge App Design 插件

forge-app-design 是 Forge 面向 Codex 的后台原型设计插件。它不替代 Product Design,也不是组件库本身;它负责把用户需求或 Product Design 产出的页面意图,转成可落地的 Forge 后台原型。

插件会约束 Codex 先确认业务目标、页面模块、核心对象和操作流程,再基于 Forge starter 与 @forge-ui-official/core 实现页面,并完成类型检查、构建、截图和质量验收。这样 AI 不是临时拼 UI,而是按 Forge 的组件、视觉基线和后台页面模式稳定交付。

详细规则、样例和验收脚本在 plugins/forge-app-design

相关项目

License

MIT

About

Showcase and documentation site for Forge UI Kit — built with Next.js 16 + Tailwind v4

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors