食品
@foodpilot/foods 是FoodPilot的React设计系统:基于MUI的组件,租户主题和图表
平台应用程序.
- 故事书: 食品-故事书 食品驾驶员 科技,组织起来像 IBM 碳的吗.
- 图片设计系统: 设计系统,则 设计真相源.
- 对于AI助手:
llms.txt(单位:千美元)维基百科中的相关条目: 维基语录链接:名人名言页:1 食品-故事手册. foodpilot.tech/llms.txt。 。 。 .
使用食物
npm install @foodpilot/foods
同伴依赖性 :
- 总是:
react财务报告和审定财务报表react-dom18或19岁,@mui/material^ 6.4, 缩写为:,@emotion/react财务报告和审定财务报表@emotion/styled^11.14, (韩语),i18next, (中文(简体) ),react-i18next财务报告和审定财务报表lodash· ; - 仅用于使用它们的组件:
@mui/icons-material, (中文(简体) ),@mui/lab,则@mui/x-*软件包,recharts财务报告和审定财务报表material-react-table。 。 。 .
import { FoodsThemeProvider } from "@foodpilot/foods/themes";
import { Button } from "@foodpilot/foods/Button";
<FoodsThemeProvider theme="foodpilot">
{/* "foodpilot" | "winepilot" | "collective" */}
<App />
</FoodsThemeProvider>;
每个导出项都从根项或组件项命名:见 进口 实例. md样式
带有主题符号(palette, 8 px 间隔, 打印变体, 阴影), 绝对没有原始值。 组件翻译
他们的文本与 react-i18next,英文字符串为密钥;应用程序提供翻译.
故事书
npm run storybook 在6006号港口服务, npm run build-storybook 把它建起来 storybook-static/编辑
demo.yml 工作流程在每次发布后都会部署.
| 节次 | 它所持有的 | 文件夹 |
|---|---|---|
| 开始 | 欢迎,以及设计者、产品和开发者的指南 | src/getting-started/ |
| 构成部分 | 由 Figma 设计系统页面使用的组件 : Action, Avatar and user, 内容, 数据显示, 反馈, 输入, Modals, 导航 | src/components/<Category>/ |
| 要件 | 地基:颜色、打字、间距、阴影、断点、图标 | src/elements/ |
| 版式 | 页面布局 | src/layout/ |
| 预览 | 仍在建造或重新设计的部件 | src/preview/ |
| 遗产 | 从Figma设计系统中取出用于屏幕的部件 | src/legacy/<Category>/ |
| 折旧 | 故意贬值 | src/deprecated/<Category>/ |
每个组成部分都有: 概览 页 次src/docs/DocsPage.tsx使用:
- 其与 Figma 设计( 其 Figma 框架的 doc 状态) 的匹配, 及其使用指南被复制的当天 从相克;
- 其说明;
- 法格玛的用法指南:做和不做,解剖,行为,内容和状态,或 无使用准则 现在· ;
- 每个故事;
- 道具(组件 API);
- 参考文献.
在故事书中:
- 每个故事都有控件,记录它的回调在 行动 并发挥主要互动作用 互动· ;
- 工具栏切换租户主题(FoodPilot、WinePilot、正文)、背景和取景口;
- 文本为英文.
贡献
一般事务人员(其他职等) 持有任何更改的规则。 简而言之:
-
故事: 一个组件的故事进入
src/components/<Category>/<Component>.stories.tsx,没有title, (中文(简体) ), 因为文件夹决定了侧边栏,它们的元从一个马厩开始id,小写中的文件名,所以 URL在移动中幸存. 它们的文本是英文,有适当的控制,fn()回调和 aplay函数. 用法指南来自Figma, inparameters.guidelines,与相克医生status编辑syncedAt日报. -
hllms.txt : (中文(简体) ) 当一个组件或其故事被添加、移动或删除、运行时
npm run llms承诺llms.txt. CI 失效时失效 . -
遗产 : 一个组件的故事移动到
src/legacy/与git mv一旦它从图片设计中移除 系统,那么llms.txt已经刷新。 前端的平台设计技巧报道了故事 平台-应用不再导入;仅此而已不会移动它们. -
检查 :
npm run prettier, (中文(简体) ),npm run lint, (中文(简体) ),npm run tsc· ;npm test,包括故事的戏剧和llms.txt检查;npm run build, (中文(简体) ),npm run depcruise:check。 。 。 .
CI描述于 文件/文件编号预算规模 Bundle analysis.md (英语)。 。 。 .
-
释放:
npm run publish:patch|minor|major发送发布工作流程从main平台应用程序获得一个 发布之后的更改以及其自身的依赖性更新.