Files
what-to-eat/docs/guide/getting-started.md
T
toor 7920c0bba2 chore: 删除设计原型目录,锁定 Node 24
移除 prototype/ 下 cook-desktop 与 cook-redesign 两套静态原型稿(37 个文件),
它们是设计过程产物,不是产品源码;eslint 的对应 ignore 规则一并撤掉。

engines.node 收紧为 >=22.0.0 <25:Node 26 下 ESLint worker 会原生崩溃
(退出码 0xC0000005),实测 Node 24 下连续 6 次 lint 全部正常。
2026-10-21 12:43:16 +08:00

81 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 快速开始
欢迎使用 Cook! 这是一个帮助你决定"今天吃什么"的应用。
## 环境准备
### 系统要求
- Node.js 24(`.nvmrc` 锁定;Node 26 上 ESLint 会原生崩溃,暂不支持)
- pnpm >= 11.21
### 安装依赖
```bash
# 克隆项目
git clone https://github.com/YunYouJun/cook.git
cd cook
# 安装依赖
pnpm install
```
## 开发
### 启动开发服务器
```bash
pnpm dev
```
访问 <http://localhost:3000> 查看应用。
### 数据管理
菜谱数据保存在本地 CSV 文件 `packages/data/recipe.csv` 中。
#### 更新菜谱数据
```bash
# 手动编辑 packages/data/recipe.csv 后转换为 JSON
pnpm convert
```
详细的 CLI 使用说明请查看 [Cook CLI 文档](/dev/cli)。
## 构建
### Web 应用
```bash
# 构建生产版本
pnpm build
# 预览构建结果
pnpm preview
```
## 项目结构
```
cook/
├── apps/web/ # Web 应用(Nuxt)
│ ├── app/ # 应用源码
│ │ ├── components/ # Vue 组件
│ │ ├── composables/# 组合式函数
│ │ ├── pages/ # 页面路由
│ │ └── utils/ # 工具函数
│ └── public/ # 静态资源
├── docs/ # 文档网站
├── packages/
│ ├── cook/ # CLI 工具与推荐/搜索核心
│ └── data/ # 菜谱数据 (CSV + JSON)
└── test/ # 测试
```
## 下一步
- 📖 查看 [CLI 文档](/dev/cli) 了解数据管理
- 💻 查看 [Web 应用开发](/dev/app) 了解技术栈与登录流程
- 🍳 开始添加你喜欢的菜谱!