快速上手
从下载到运行、添加模块、配置、连接真实后端、设计和更新,第一天需要的步骤都在这里。
在价格页面通过 PayPal 购买你需要的版本。这是一次性购买,不是订阅。
页头的“我的账号”→“我的产品”。React、Vue 和 Next.js 的 zip 包中,版本文件夹与共用的模拟后端(initfn-mock)并列存放。
initfn-react-1.0.0/
initfn-react/ # React edition
initfn-mock/ # mock backend (found at ../initfn-mock - keep both side by side)Node.js 24(见各版本的 .nvmrc)和 npm。Vanilla 不需要。
先启动模拟后端,再启动应用。使用 admin / 1234 登录。
cd initfn-mock && npm i && cd ..
cd initfn-react && npm i # initfn-vue for Vue
npm run mock # mock backend http://localhost:4000
npm run dev # React :4001 · Vue :4003 · docs at /doc可以只启动 Next 服务器(单体架构),也可以连接模拟后端。
cd initfn-nextjs && npm i
npm run mock # when using the mock backend
npm run dev # http://localhost:4002 · docs at /doc无需构建。在浏览器中打开 _guide 里的 HTML 文件查看用法和示例源码,然后在页面中引入 css、js 和 font 文件夹。
React、Vue 和 Next.js 版用一条命令即可添加或移除 50 个模块中的任意一个 - 页面、API 和菜单随之一起加入或移除。
npm run preset # list modules
npm run preset add social-login mfa # add
npm run preset remove mfa # removeReact、Vue、Next.js 版的配置分成三个文件。.env 放开发和生产共用的值(像站点名这样不保密的值),.env.development 只在开发时用,.env.production 只在生产环境用。三个文件都不提交到 git,只想在自己电脑上改的值放在 .env.local。
.env # shared, not secret - site name, public IDs
.env.development # dev only - local backend URL, sandbox keys
.env.production # production only - live URL, live keys, analytics ID
.env.local # your machine only (overrides the others)添加模块时,该模块需要的配置键会带着说明注释加到对应文件末尾,最后列出还需要填写的键。已有的值不会被改动,移除模块也不会删除这些值。
npm run preset add paypal
# -> adds PAYPAL_* keys to .env.development
# and .env.production, then lists keys to fill后端地址只需 core/config/apiConfig.js 表里的一行,加上 .env.development(生产环境用 .env.production)里的一行地址。页面代码不用改。
# .env.development (production: .env.production)
BACKEND_API_URL=http://your-backend:8080initfn-mock/openapi.yaml 描述了前端期望的 API。把它交给后端开发者 - 按此响应的后端无需改代码即可接入。
样式分为三层。颜色、字体、圆角、阴影等值写在 initfn-token.css,按钮、输入框、卡片、区块等小 UI 的样子写在 initfn-base.css,页面、版块等较大的设计写在 initfn-global.css。只想换品牌色,改 token 文件末尾的 --color-brand-* 即可。
src/core/style/ # Vanilla: css/ · font/ · image/
css/initfn-token.css # values - colors, fonts, radius, shadows
css/initfn-base.css # small UI, components, blocks
css/initfn-global.css # pages and sections
font/ image/给出设计稿或想要的感觉,让它先读版本里自带的设计技能再修改。这个技能为每种需求定好了该改哪个文件,所以 AI 不会动页面代码,只改这三个文件。
.claude/skills/ssr-design/ # Next.js
.claude/skills/csr-design/ # React
.claude/skills/vue-design/ # Vue
.claude/skills/vanilla-design/ # VanillaCSS 每条规则写成一行(只有 token 文件换行),在 VS Code 里保存时会自动整理。字体只加载页面需要的 Pretendard 分片,首屏字体约 1MB。React、Vue、Next.js 版使用公共 Image 组件时,图片会懒加载,并以 avif/webp 轻量输出。
npm run format # tidy CSS - one rule per line
node scripts/format-css.mjs # VanillaReact、Vue、Next.js 版只需用新 zip 里的 .preset 文件夹覆盖项目中的 .preset,然后运行 update。列表中 ⬆ 表示已安装模块有新版本,🆕 表示新增的模块。你改过的文件不会被覆盖,新版本会以 .preset-new 放在旁边,对比合并后删掉即可。
# 1. copy .preset from the new zip over your project's .preset
npm run preset # 2. list - ⬆ update available · 🆕 new module
npm run preset update # 3. update installed modules
npm run preset add <name> # 4. add a new module
npm run lint && npm test && npm run build装了哪些模块、是哪个版本,都记录在项目根目录的 preset.lock.json 里。它放在 .preset 文件夹之外,整个覆盖该文件夹也不会丢失记录,请一起提交到 git。
如果连 core、shared 等基础代码的改进也想拿到,就用 zip 建一个 git 仓库,把未改动的原始版本放在 initfn 分支上。自己的工作在 main 上进行。
git init && git add . && git commit -m "initfn 1.0.0"
git branch initfn # untouched original从账户下载新的 zip,覆盖到 initfn 分支后合并到 main,再运行 npm run preset update 同步已安装的模块。只有与你改过的地方重叠的部分才会出现冲突。变更内容见发布说明。
git switch initfn
# unzip the new version over it (keep node_modules and your .env files)
git add -A && git commit -m "initfn 1.1.0"
git switch main && git merge initfn
npm run preset update # sync installed modules每个版本的命令名称都相同。
npm run lint && npm test # rules and unit tests
npm run build # production build
npm run test:e2e # browser E2E部署方法见应用内的开发指南(/doc)。部署或交付最终产品时,请附上版本中的 THIRD_PARTY_NOTICES.md(开源声明)。
完整的详细指南随项目压缩包一同提供。 本页只介绍第一天需要知道的内容。其余的一切 - 安装、配置、组件、模块和部署 - 都在下载的压缩包里:内置指南站(7 种语言)、README 以及面向 AI 编程工具的文档(AGENTS.md)。
请查看常见问题和许可协议,或发邮件至 numerxlab@gmail.com 告诉我们。