ERP beyond your fridge - Grocy is a web-based self-hosted groceries & household management solution for your home
Go to file
google-labs-jules[bot] ee0561e187 fix: Make release workflow tag trigger more flexible
This commit updates the GitHub Actions workflow for releases to be more flexible.

The workflow will now trigger on tags that follow either the 'v*.*.*' pattern or the '*.*.*' pattern. This allows the user to create releases using tags with or without a 'v' prefix (e.g., 'v1.2.3' or '1.2.3').
2025-08-15 14:19:05 +00:00
.devtools Reduce package size 2025-02-27 18:01:18 +01:00
.github fix: Make release workflow tag trigger more flexible 2025-08-15 14:19:05 +00:00
.tx New Transifex command-line client compatibility 2022-02-13 18:25:42 +01:00
.vscode Fixed conflicting php-cs-fixer VSCode setting 2022-09-28 11:17:03 +02:00
changelog Allow German Umlauts in OOF plugin product names (fixes #2740) 2025-06-07 18:00:38 +02:00
controllers feat: Adapt Grocy for the Chinese market 2025-08-13 13:55:17 +00:00
data Finalized frontend external barcode lookup implementation (references #158) 2025-01-12 13:58:47 +01:00
docs New logo 2023-05-19 18:08:26 +02:00
helpers Automate manual update steps (closes #2384) 2025-01-12 15:24:18 +01:00
localization feat: Adapt Grocy for the Chinese market 2025-08-13 13:55:17 +00:00
middleware Upgraded PHP-CS-Fixer / applied optimized rules 2023-08-02 18:44:30 +02:00
migrations feat: Adapt Grocy for the Chinese market 2025-08-13 13:55:17 +00:00
plugins Allow German Umlauts in OOF plugin product names (fixes #2740) 2025-06-07 18:00:38 +02:00
public feat: Adapt Grocy for the Chinese market 2025-08-13 13:55:17 +00:00
services Added option to include details in the webhook sent to label printers (#2704) 2025-03-21 16:34:33 +01:00
views feat: Adapt Grocy for the Chinese market 2025-08-13 13:55:17 +00:00
.editorconfig Added an EditorConfig file 2020-08-29 16:10:05 +02:00
.gitattributes Added a .gitattributes file (references #412) 2019-11-02 08:40:03 +01:00
.gitignore Renamed third party packages directories 2023-06-03 17:36:01 +02:00
.php-cs-fixer.php Upgraded PHP-CS-Fixer / applied optimized rules 2023-08-02 18:44:30 +02:00
.yarnrc Renamed third party packages directories 2023-06-03 17:36:01 +02:00
app.php Clear /data/viewcache also when BASE_URL or BASE_PATH changed (references #2384) 2025-01-17 17:13:11 +01:00
composer.json Visual refresh 2025-01-08 20:50:35 +01:00
composer.lock Updated dependencies 2025-06-07 17:27:22 +02:00
config-dist.php Change the default Grocycode type to DataMatrix 2025-03-21 17:49:31 +01:00
Dockerfile fix: Correct data directory mapping in Dockerfile 2025-08-15 10:59:11 +00:00
grocy.openapi.json fix(openapi): volatile is not an array, it's an object (#2694) 2025-03-10 17:22:56 +01:00
LICENSE Initial commit 2017-04-15 21:45:44 +02:00
package.json Replaced barcode scanning library with ZXing (#2706) 2025-03-21 17:41:39 +01:00
README.md fix: Make release workflow tag trigger more flexible 2025-08-15 14:19:05 +00:00
release.sh fix: Make release workflow tag trigger more flexible 2025-08-15 14:19:05 +00:00
routes.php feat: Adapt Grocy for the Chinese market 2025-08-13 13:55:17 +00:00
TODO.md feat: Adapt Grocy for the Chinese market 2025-08-13 13:55:17 +00:00
update.sh data/viewcache is now cleared automatically (references #2384) 2025-01-13 18:08:20 +01:00
version.json Prepared next release 2025-03-28 19:54:16 +01:00
yarn.lock Updated dependencies 2025-06-07 17:27:22 +02:00

Logo

AnticlockwiseGrocy - 逆时针

一个专为中国家庭打造的家庭物品管理神器

让我们一起,有效管理库存,利用资源,实现断舍离,减少浪费,聚焦重点。


核心理念

在现代快节奏的生活中我们常常被繁杂的家务和无尽的物品所困扰。AnticlockwiseGrocy逆时针旨在帮助您和您的家庭

  • 告别混乱:清晰记录每件物品的位置、数量和保质期,让您的家井井有条。
  • 践行断舍离:通过“闲置物品”报告等功能,轻松识别长期不用的物品,向不必要的囤积说再见。
  • 减少浪费:智能提醒即将过期的食品,让每一份食材都物尽其用。
  • 高效生活:无论是购物清单、菜谱计划还是家务分配,都为您安排得明明白白。

我们相信,通过管理好身边的“物”,可以更好地管理我们的时间与生活,将精力聚焦于更重要的人和事。

功能亮点

  • 库存管理:随时掌握家中食品、日用品等所有物品的库存情况。
  • 购物清单:智能生成购物清单,缺少的物品一目了然,避免重复购买。
  • 菜谱计划:轻松规划每周菜单,并根据菜谱自动检查库存。
  • 家务管理:创建家务计划,并分配给家庭成员,让家务不再是难题。
  • 闲置物品报告:一键找出那些被遗忘在角落的物品,帮助您做出“断舍离”的决策。
  • 保质期提醒:自动提醒即将过期的产品,有效减少食物浪费。
  • 专为中国优化:内置了“斤”、“克”、“个”等符合中国人使用习惯的数量单位。

如何安装和使用

我们深知不是每个人都是技术专家。因此,我们正在努力提供更简单的安装方式。

方式一:使用 Docker推荐

对于有一定技术基础的用户,我们推荐使用 Docker 进行安装。这是最快、最稳定的方式。

我们的 Docker 镜像基于本项目的源代码构建,默认使用中文界面,并已为您准备好一切。

  1. 拉取镜像

    docker pull nishizhen/anticlockwisegrocy:latest
    
  2. 运行容器

    docker run -d \
      --name=anticlockwisegrocy \
      -p 9283:80 \
      -v /path/to/your/data:/config \
      nishizhen/anticlockwisegrocy:latest
    

    请注意

    • -p 9283:80:将容器的 80 端口映射到您服务器的 9283 端口。您可以根据需要更改 9283
    • -v /path/to/your/data:/config:将您的数据持久化存储在本地。请务必将 /path/to/your/data 替换为您服务器上的一个真实路径,例如 /home/user/grocy_data
  3. 访问应用 打开浏览器,访问 http://<您的服务器IP>:9283。 默认登录用户为 admin,密码为 admin,请在登录后立即修改密码。

方式二:手动安装

对于熟悉网站环境搭建的用户,可以选择手动安装。

1. 下载预编译包

您可以直接从本项目的 GitHub Releases 页面下载最新的 grocy_x.x.x.zip 包。这个包里已经包含了所有必需的依赖,开箱即用。

2. 自行打包(适合开发者)

如果您想基于最新的源代码自行打包,可以按以下步骤操作:

  1. 确保您的开发环境中已安装 bash, zip, composeryarn
  2. 在项目根目录下,运行打包脚本:
    ./release.sh
    
  3. 脚本执行成功后,会在项目根目录下生成一个 grocy_x.x.x.zip 文件。

3. 安装步骤

获取到 zip 包后,请按照以下步骤进行安装:

  1. zip 包解压到您的网站服务器的指定目录。
  2. config-dist.php 复制为 data/config.php,并根据您的需求进行修改。
  3. 确保 data 目录具有写入权限。
  4. 将您的网站服务器根目录指向 public 目录。
  5. 默认登录用户为 admin,密码为 admin,请在登录后立即修改密码。

4. 自动发布 (GitHub Actions)

本项目已配置 GitHub Actions,可以在您创建新的 release 时自动构建和上传安装包。

要触发自动发布,请按以下步骤操作:

  1. 确保您的代码已提交到 master 分支。
  2. 基于 master 分支创建一个新的 tag并推送到 GitHub。tag 的名字需要符合 v*.*.* 的格式,例如 v1.2.3
    git tag v1.2.3
    git push origin v1.2.3
    
  3. 推送 tag 后GitHub Actions 会自动开始构建,并将生成的 grocy_x.x.x.zip 文件上传到您刚刚创建的 release 页面。

更多详细的安装说明和帮助,请参考原版 Grocy 的文档。我们正在努力编写更符合中国用户习惯的中文文档。

未来计划 (Roadmap)

为了让 AnticlockwiseGrocy 更贴近中国家庭的需求,我们规划了以下功能(欢迎您提供宝贵的建议!):

  • [进行中] 更强大的条码扫描:集成更适合中国市场的商品条码查询服务,实现扫码即可录入商品信息。
  • [计划中] 与微信集成
    • 通过微信接收保质期提醒、购物清单通知。
    • 与家人通过微信共享购物清单。
  • [计划中] 中式菜谱优化
    • 接入“下厨房”等中文菜谱网站,一键导入菜谱。
    • 根据农历节气,智能推荐时令菜谱(如:端午节推荐粽子,中秋节推荐月饼)。
  • [计划中] 更多“断舍离”辅助功能
    • “捐赠/丢弃”建议功能,智能识别可处理的闲置物品。
    • 可视化浪费报告,追踪被丢弃物品的价值,让您对消费有更清晰的认识。
  • [计划中] 移动端体验优化
    • 针对手机进行界面优化,使其更符合移动优先的使用习惯。
    • 开发微信小程序或 PWA 应用,提供更流畅的移动体验。
  • [计划中] 一键部署方案
    • 提供在阿里云、腾讯云等国内主流云服务商上的一键部署脚本。
    • 探索更简单的桌面版或轻量级部署方案。

参与贡献

本项目是开源的,我们欢迎任何形式的贡献,无论是代码、文档、还是一个好的想法。

  • 问题反馈与功能建议:请通过 Issue Tracker 告诉我们。
  • 参与翻译:如果您想帮助我们改进翻译,可以访问 Transifex

本项目基于 Grocy 进行二次开发,感谢原作者 Bernd Bestel 的辛勤付出。