d3b933cca5
- 将 scripts/ 迁移至 packages/cook CLI 工具（飞书 fetch、CSV convert、单元测试） - 新增 packages/types 共享类型包，抽取 app/types 类型定义 - 更新依赖（nuxt 4.4、vite 8、eslint 10.1 等） - 新增 vitest coverage 配置 - 更新文档和配置（CLAUDE.md、.env.example、pnpm-workspace）
130 lines
3.3 KiB
Markdown
130 lines
3.3 KiB
Markdown
# Cook
|
||
|
||
> 好的，今天我们来做菜 🥬
|
||
> Note: This is primarily a Chinese project and we do not intend to translate to English due to the fact that all the ingredients we are familiar with are in Chinese.
|
||
|
||
## 版本
|
||
|
||
[](https://github.com/YunYouJun/cook/actions/workflows/release.yml)
|
||
|
||
### 网页版本
|
||
|
||
- 网站链接（Cloudflare）：[cook.yunyoujun.cn](https://cook.yunyoujun.cn)
|
||
- 国内加速（腾讯云）：[cook.yunle.fun](https://cook.yunle.fun)
|
||
- 备用（Netlify）：[cook.yyj.moe](https://cook.yyj.moe)
|
||
- 开发版（Vercel）：[cook.yunle.app](https://cook.yunle.app)
|
||
|
||
### 小程序版本
|
||
|
||
~~本仓库为网页版本，小程序版本请在微信搜索「来做菜」。~~
|
||
|
||
因不可抗力，小程序因跳转 B 站视频而被判定为导流违规下架。
|
||
将不再提供小程序版本。
|
||
|
||
<!--  -->
|
||
|
||
## 说明
|
||
|
||
本项目初衷是方便特殊时期隔离在家而材料有限的小伙伴，因此菜谱材料会尽量限制在特定范围内。
|
||
|
||
更多可参见 [来做菜 | 关于](https://cook.yunyoujun.cn/about)。
|
||
|
||
欢迎反馈更多菜谱数据：
|
||
|
||
- 相关链接
|
||
- [菜谱数据表格（飞书）](https://yunlefun.feishu.cn/wiki/KgxowvnB9iM91AkZEJHcNGoQnPg?sheet=X4j9Bn)
|
||
- [居家菜谱投稿](https://docs.qq.com/form/page/DWk9GWW9oTmlXZU9V)
|
||
- [反馈建议分享-兔小巢](https://support.qq.com/products/507827)
|
||
|
||
### Features
|
||
|
||
~~本项目支持 PWA，使用浏览器打开时，可将其添加到主屏幕以获得近原生 APP 的体验。~~
|
||
|
||
我们正在开发新的 APP 版本，敬请期待。
|
||
|
||
## 开发
|
||
|
||
### 环境配置
|
||
|
||
如需从飞书拉取菜谱数据,请先配置环境变量:
|
||
|
||
```bash
|
||
# 复制环境变量模板
|
||
cp .env.example .env
|
||
|
||
# 编辑 .env 文件,填入飞书应用凭证
|
||
# FEISHU_APP_ID=cli_xxxxxxxxxxxxxxxx
|
||
# FEISHU_APP_SECRET=xxxxxxxxxxxxxxxxxxxxxxxx
|
||
```
|
||
|
||
获取飞书凭证请访问 [飞书开放平台](https://open.feishu.cn/app)。
|
||
|
||
详细配置说明请查看 [文档](https://cook.yunyoujun.cn/docs/)。
|
||
|
||
### 启动项目
|
||
|
||
```bash
|
||
# 安装依赖
|
||
pnpm install
|
||
|
||
# 从飞书拉取最新数据(可选)
|
||
pnpm fetch
|
||
|
||
# 或将本地 CSV 转换为 JSON
|
||
pnpm convert
|
||
|
||
# 启动开发服务器
|
||
pnpm dev
|
||
# http://localhost:3333
|
||
```
|
||
|
||
### CLI 命令
|
||
|
||
```bash
|
||
# 从飞书拉取菜谱数据
|
||
pnpm fetch
|
||
|
||
# 将 CSV 转换为 JSON
|
||
pnpm convert
|
||
```
|
||
|
||
更多 CLI 使用说明请查看 [Cook CLI 文档](https://cook.yunyoujun.cn/docs/dev/cli)。
|
||
|
||
### 开发 APP
|
||
|
||
> [Local Development](https://ionic.nuxtjs.org/cookbook/local-development)
|
||
|
||
## 部署
|
||
|
||
### Docker
|
||
|
||
```bash
|
||
# 从 Docker Hub 拉取最新的镜像
|
||
docker pull yunyoujun/cook:latest
|
||
# 新建并启动容器，然后打开 http://localhost:3333
|
||
docker run -it -d --name cook -p 8080:80 yunyoujun/cook:latest
|
||
|
||
# 启动与停止
|
||
docker start cook
|
||
docker stop cook
|
||
```
|
||
|
||
## 致谢
|
||
|
||
感谢以下小伙伴为本项目提供的数据支持和 QA ！
|
||
|
||
- [Runny](https://weibo.com/runny)
|
||
- 麒麟
|
||
- 晴方啾
|
||
- 课代表阿伟
|
||
|
||
## [Sponsors](https://sponsors.yunyoujun.cn)
|
||
|
||
感谢至今以来的所有赞助者们！因为你们的支持让我更有动力去做各种尝试。
|
||
|
||
<p align="center">
|
||
<a href="https://cdn.jsdelivr.net/gh/YunYouJun/sponsors/public/sponsors.svg">
|
||
<img src='https://cdn.jsdelivr.net/gh/YunYouJun/sponsors/public/sponsors.svg' alt='Sponsors'/>
|
||
</a>
|
||
</p>
|