@yoyaflow/yoya-ui 0.2.1 → 0.3.0

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 CHANGED
@@ -44,6 +44,22 @@ function HelloWorldExampleI18n() {
44
44
 
45
45
  ## Installation
46
46
 
47
+ ### Scaffold a new project
48
+
49
+ ```bash
50
+ npx create-yoya-ui@latest my-app # basic template (SPA)
51
+ npx create-yoya-ui@latest my-app --template ssr # SSR template (renderPage + hydrateOrMount)
52
+ npx create-yoya-ui@latest my-app --template admin # admin console template (top nav + collapsible sidebar + RouterViews)
53
+ cd my-app
54
+ npm install
55
+ npm run dev # basic / admin: dev server
56
+ # SSR: npm run build && npm start
57
+ ```
58
+
59
+ `--template admin` scaffolds a standard admin console: top navigation, collapsible sidebar and a titled RouterViews content area, with feature examples for dashboard (data boards & charts), member / role / permission management, and dictionary management (type table with an item editor dialog).
60
+
61
+ ### Install into an existing project
62
+
47
63
  ```bash
48
64
  npm install @yoyaflow/yoya-ui
49
65
  ```
package/README.zh-CN.md CHANGED
@@ -45,6 +45,22 @@ function HelloWorldExampleI18n() {
45
45
 
46
46
  ## 安装
47
47
 
48
+ ### 脚手架快速搭建
49
+
50
+ ```bash
51
+ npx create-yoya-ui@latest my-app # basic 模板(SPA)
52
+ npx create-yoya-ui@latest my-app --template ssr # SSR 模板(renderPage + hydrateOrMount)
53
+ npx create-yoya-ui@latest my-app --template admin # admin 后台管理模板(顶部导航 + 可折叠侧栏 + RouterViews)
54
+ cd my-app
55
+ npm install
56
+ npm run dev # basic / admin:开发服务器
57
+ # SSR:npm run build && npm start
58
+ ```
59
+
60
+ `--template admin` 生成标准后台管理模板:顶部导航 + 可折叠侧栏 + 带标题的 RouterViews 内容区,内置数据概览看板与图表,以及成员 / 角色 / 权限 / 字典管理等业务域示例。
61
+
62
+ ### 已有项目引入
63
+
48
64
  ```bash
49
65
  npm install @yoyaflow/yoya-ui
50
66
  ```