Recipe Buddy 项目使用教程

Recipe Buddy 项目使用教程

recipe-buddy Recipe Buddy is a tool that enables the easy adding of recipes to Grocy through web scraping. 项目地址: https://gitcode.com/gh_mirrors/re/recipe-buddy

1. 项目目录结构及介绍

Recipe Buddy 的目录结构如下：

recipe-buddy/
├── .github/              # GitHub 工作流和配置文件
├── .idea/                # IntelliJ IDEA 项目配置文件
├── public/               # 公共静态文件
├── scripts/              # 脚本文件
├── src/                  # 源代码目录
│   ├── components.json   # 组件配置文件
│   ├── drizzle.config.ts # Drizzle 配置文件
│   ├── knip.json         # Knip 配置文件
│   ├── next.config.js    # Next.js 配置文件
│   ├── package.json      # 项目依赖和脚本
│   ├── postcss.config.cjs # PostCSS 配置文件
│   ├── tailwind.config.js # Tailwind CSS 配置文件
│   └── tsconfig.json     # TypeScript 配置文件
├── .dockerignore         # Docker 忽略文件
├── .env.example          # 环境变量示例文件
├── .eslintrc.json        # ESLint 配置文件
├── .gitignore            # Git 忽略文件
├── Dockerfile            # Docker 构建文件
├── LICENSE               # 许可证文件
├── README.md             # 项目说明文件
├── SECURITY.md           # 安全策略文件
└── pnpm-lock.yaml        # pnpm 锁文件

每个目录和文件的具体用途在上述结构中已经简要说明。

2. 项目的启动文件介绍

项目的启动主要通过 Dockerfile 进行容器化部署。以下是 Dockerfile 的基本内容：

# 使用 Node.js 官方基础镜像
FROM node:14

# 创建应用目录
WORKDIR /home/node/app

# 复制项目文件到容器中
COPY . .

# 安装项目依赖
RUN npm install

# 设置环境变量
ENV GROCY_API_KEY=YOUR_GROCY_API_KEY
ENV GROCY_BASE_URL=YOUR_GROCY_BASE_URL
ENV NEXTAUTH_SECRET=YOUR_AUTH_SECRET
ENV NEXTAUTH_URL=http://localhost:3005

# 暴露容器端口
EXPOSE 3000

# 运行项目
CMD ["npm", "run", "dev"]

要启动项目，你需要先设置环境变量，然后运行以下命令：

docker run \
-p 3005:3000 \
-v rb_data:/home/node/app/data \
--env GROCY_API_KEY=YOUR_GROCY_API_KEY \
--env GROCY_BASE_URL=YOUR_GROCY_BASE_URL \
--env NEXTAUTH_SECRET=YOUR_AUTH_SECRET \
--env NEXTAUTH_URL=http://localhost:3005 \
ghcr.io/georgegebbett/recipe-buddy

3. 项目的配置文件介绍

项目的主要配置文件包括：

• package.json：定义了项目的依赖、脚本和元数据。
• .env.example：包含了项目需要的环境变量示例。
• next.config.js：Next.js 的配置文件，用于自定义 Web 应用的行为。
• tailwind.config.js：Tailwind CSS 的配置文件，用于自定义样式。
• tsconfig.json：TypeScript 的配置文件，用于指定编译选项。

确保在使用前正确设置 package.json 中的环境变量，并参考 .env.example 创建一个 .env 文件来存储实际的配置值。

recipe-buddy Recipe Buddy is a tool that enables the easy adding of recipes to Grocy through web scraping. 项目地址: https://gitcode.com/gh_mirrors/re/recipe-buddy