ever-co/ever-gauzy 来源：https://github.com/ever-co/ever-gauzy # Ever Gauzy 平台 [uri_gauzy]: https://gauzy.co [uri_license]: https://www.gnu.org/licenses/agpl-3.0.html [uri_license_image]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg 访问者 [![许可证：AGPL v3][uri_license_image]][uri_license] 向 DeepWiki 提问 (https://deepwiki.com/ever-co/ever-gauzy) Gitpod 准备就绪，可开始编码 (https://gitpod.io/#https://github.com/ever-co/ever-gauzy) ## 💡 最新动态 - 🔥🔥🔥 我们刚刚发布了 Ever Works (https://github.com/ever-works/ever-works) - 一个开放的智能体运行时，可自主研究、交付和维护整个业务，全天候运行。请立即从 GitHub 获取并为其点亮 ⭐⭐⭐！ - 如果您喜欢 Gauzy，您也应该看看 Ever Teams (https://github.com/ever-co/ever-teams) - 开放的工作与生产力平台。请查看并在 GitHub 上为其点亮 ⭐！它使用 React (NextJs) / ReactNative (Expo) 技术栈构建，并连接到无头的 Ever Gauzy 平台 API (https://api.gauzy.co/docs)。 ## 🌟 这是什么 [Ever® GauzyTM][uri_gauzy] - 开放业务管理平台，面向协作经济、按需经济和共享经济。 - 企业资源规划 (ERP) - 客户关系管理 (CRM) - 人力资源管理 (HRM) - 申请人追踪系统 (ATS) - 工作与项目管理 (PM) - 员工时间追踪、活动与生产力追踪 Ever® GauzyTM 平台是我们更大的协作经济、按需经济和共享经济开放平台 - Ever® PlatformTM (https://ever.co) - 的一部分。 ## ✨ 功能特性 主要功能： - 人力资源管理 (HRM)，包含时间管理/追踪与员工绩效监控 - 客户关系管理 (CRM) - 企业资源规划 (ERP) - 项目/任务管理 - 销售管理 - 财务与成本管理（包括 会计、开票 等） - 库存、供应链管理与生产管理 平台提供的更详细功能列表： - 无头 API (https://api.gauzy.co/docs) - 仪表板（提供不同指标的概览，如公司收入/支出、员工奖金等） - 时间管理/时间追踪/活动追踪/工时表 - 员工管理（公司员工/承包商登记、员工费率等） - 员工入职 - 申请人追踪系统 (ATS) / 候选人面试 - 联系人管理（客户/客户/潜在客户等） - 日程安排/预约/活动 - 项目管理/任务 - 目标/KPI/目标/关键结果 - 销售管道 - 提案 - 会计/开票/估算 - 计费 - 支付 - 收入/支出管理 - 休假管理/假期/审批 - 库存 - 设备/共享 - 多组织管理 - 组织部门与团队 - 组织客户与供应商 - 帮助中心/知识库 - 标签/标签 - 报告/洞察/分析 - 组织与员工公开页面 - 集成（Upwork, HubStaff 等） - 电子邮件历史记录/电子邮件模板 - 数据导入/导出 - 角色/权限 - 多币种 - 多语言 - 深色/浅色/企业/材料等主题 阅读更多关于 Gauzy 的信息 (https://github.com/ever-co/ever-gauzy/wiki/About-Gauzy) 以及如何在您的公司、按需业务、自由职业、代理机构、工作室或内部团队中使用它 (https://github.com/ever-co/ever-gauzy/wiki/How-to-use-Gauzy)。 ## 🌼 截图 显示/隐藏截图 ### Web UI 概览 ### 桌面计时器 UI (标准) 计时器 ### 桌面计时器 UI (扩展) 计时器 ## 🔗 链接 - **** - 在官方网站上查看更多关于平台的信息。 - **** - SaaS（重要提示：目前处于 Alpha 版本/测试模式，请谨慎使用）。 - **** - 在线演示（见下方更多信息）。 - **** - 下载平台与应用（也请参阅下方关于可用下载的更多信息）。 - **** - 平台文档（进行中）。另请参阅我们的 Wiki (https://github.com/ever-co/ever-gauzy/wiki)。 - **** - 了解更多关于我们公司产品的信息。 ## 📊 活动 替代方案 ## 💻 演示、下载、测试与生产环境 ### 演示 Ever Gauzy 平台演示位于 。 注意事项： - 默认超级管理员用户登录邮箱为 [email protected]，密码为 admin - 演示数据库内容每次部署到演示环境时都会重置（通常每天一次） - 演示环境使用 CI/CD 从 develop 分支部署 ### 下载 您可以从官方下载页面 (https://web.gauzy.co/downloads) 下载 Gauzy 平台、Gauzy 服务器或桌面应用（Windows/Mac/Linux）。此外，所有发布版和预发布版的下载也可从以下页面获取： - 平台发布版 (https://github.com/ever-co/ever-gauzy/releases) - 应用 (https://github.com/ever-co/ever-gauzy/wiki/Gauzy-Desktop-Apps) ### 生产环境 (SaaS) Ever® GauzyTM 平台 SaaS 可在 访问。 注意：目前处于 Alpha 版本/测试模式，请谨慎使用！ ### 预发布环境 - Gauzy 平台预发布构建（使用 CI/CD，来自 stage 分支）可在 获取 - 我们使用预发布环境在部署到生产环境之前测试发布版 - 我们桌面/服务器应用的预发布版从此环境构建，可以在设置中手动配置连接到预发布 API： ### 服务器与桌面应用 我们提供 Gauzy 服务器和两个桌面应用（适用于 Windows/Mac/Linux）： - Ever® GauzyTM 服务器 - 包含 Gauzy API、SQLite 数据库（或连接到外部 PostgreSQL）并服务 Gauzy 前端。它允许为多个客户端（基于浏览器或基于桌面）快速运行 Gauzy 服务器。如果您想在中小型组织中设置 Ever Gauzy 平台，这是推荐选项。 - Ever® GauzyTM 桌面应用 - 包含 Gauzy 前端 (UI)、Gauzy API、SQLite 数据库等，一体化！它允许在本地快速运行整个 Gauzy 解决方案，包括 UI 和计时器（当然，时间追踪是可选的）。此外，它还允许您连接到外部数据库（例如 PostgreSQL）或外部 API（如果您在其他计算机上安装了带有 API/数据库的 Gauzy 服务器，或者您想连接到我们的实时 API）。如果您想快速尝试 Gauzy / 个人使用，或者您想以“客户端-服务器”配置连接到 Gauzy 服务器（并使用桌面应用代替 Web 浏览器），这是推荐选项。 - Ever® GauzyTM 桌面计时器应用 - 允许对员工/承包商进行时间和活动追踪，包含屏幕截图和活动监控。如果组织员工不关心 Gauzy 平台的其他功能（例如会计），只需要追踪工作时间，建议设置此应用。 更多关于我们的服务器与桌面应用的信息： - 从官方下载页面 (https://web.gauzy.co/downloads) 下载适用于您操作系统的版本，或参阅上方“下载”部分获取我们发布页面的其他链接。 - 在设置向导中使用默认选项设置 Gauzy 服务器并运行它。 - 您还可以设置 Gauzy 桌面应用（可以独立运行或连接到 Gauzy 服务器）或 Gauzy 桌面计时器应用（应连接到 Gauzy 服务器）。 - 如果您安装了 Gauzy 服务器，您可以使用邮箱 [email protected] 和密码 admin 登录以检查管理员功能。注意：此类管理员用户不是员工，因此您无法追踪时间。 - 您可以使用邮箱 [email protected] 和密码 12345678 登录以检查 Gauzy UI 中与员工相关的功能，或从“员工”角度运行桌面计时器（此类用户是员工，可以追踪时间）。 - 如果您安装了 Gauzy 服务器，可以使用浏览器（默认为 ）或使用 Gauzy 桌面应用连接到它（确保配置桌面应用连接到位于 的 Gauzy API，因为这是 Gauzy 服务器 API 默认运行的位置）。 - 您可以在桌面应用 Wiki 页面 (https://github.com/ever-co/ever-gauzy/wiki/Gauzy-Desktop-Apps) 和我们的服务器 Wiki 页面 (https://github.com/ever-co/ever-gauzy/wiki/Gauzy-Server) 上阅读更多关于我们桌面应用和服务器的信息。 ## 🧱 技术栈与要求 - TypeScript (https://www.typescriptlang.org) - NodeJs (https://nodejs.org) / NestJs (https://github.com/nestjs/nest) - Nx (https://nx.dev) / Lerna (https://github.com/lerna/lerna) - Angular (https://angular.io) / RxJS (http://reactivex.io/rxjs) / Ngx-admin (https://github.com/akveo/ngx-admin) - TypeORM (https://github.com/typeorm/typeorm) / MikroORM (https://github.com/mikro-orm/mikro-orm) / Knex (https://github.com/knex/knex) 对于生产环境，我们建议使用： - PostgreSQL (https://www.postgresql.org) 或 MySQL (https://dev.mysql.com) - Kubernetes (https://kubernetes.io), Docker (https://www.docker.com) 注意：得益于 TypeORM / MikroORM，Gauzy 将支持多种数据库：SQLite（默认，用于演示）、PostgreSQL（开发/生产）、MySql（开发/生产）、MariaDb、CockroachDb、MS SQL、Oracle、MongoDb 等（只需极少更改）。 #### 另请参阅相关文件夹中的 README.md 和 CREDITS.md 文件，了解平台包含的库和软件列表、许可信息及其他详细信息。 ## 📄 文档 请参阅我们的官方平台文档 (https://docs.gauzy.co) 和我们的 Wiki (https://github.com/ever-co/ever-gauzy/wiki)（进行中）。 ## 🚀 快速开始 ### 超快速开始 。 注意：目前处于 Alpha 版本/测试模式，请谨慎使用！ ### 使用 Docker Compose 运行 - 克隆仓库。 - 确保您本地安装了最新版本的 Docker Compose (https://docs.docker.com/compose/install)。重要提示：您需要至少 v2.20 (https://docs.docker.com/compose/release-notes/#2200)。 #### 演示 - 如果您想使用我们预构建的 Docker 镜像以基本配置（例如用于演示/探索功能/快速运行）运行平台，请运行 docker-compose -f docker-compose.demo.yml up。查看 .env.demo.compose 文件了解不同设置（可选），例如数据库类型。（注意：Docker Compose 将使用通过 GitHub CI/CD 自动从 master 分支最新提交预构建的最新镜像。） - 在浏览器中打开 。 - 使用邮箱 [email protected] 和密码：admin 登录超级管理员用户。 - 使用邮箱 [email protected] 和密码：12345678 登录员工用户。 - 享受！ #### 生产环境 - 编辑 .env.compose：您必须将 JWT_SECRET、JWT_REFRESH_TOKEN_SECRET、JWT_VERIFICATION_TOKEN_SECRET 和 EXPRESS_SESSION_SECRET 设置为强大、唯一的值（例如 openssl rand -hex 64）。API 拒绝使用附带的空白/默认密钥启动——共享默认密钥允许任何人伪造认证令牌和会话。同时调整其中的任何其他设置（例如数据库类型）。 - 如果您想使用我们预构建的 Docker 镜像以最小生产配置运行平台，请运行 docker-compose up -d。（注意：Docker Compose 将使用通过 GitHub CI/CD 自动从 master 分支最新提交预构建的最新镜像。） 注意：我们建议在生产工作负载中使用 Kubernetes 代替 Docker Compose！ #### 构建 - 如果需要，编辑 .env.compose 以使用您的自定义设置，例如数据库类型。 - 如果您想在本地构建所有内容（代码和 Docker 镜像），请运行 docker-compose -f docker-compose.build.yml up -d。（注意：这是一个极其漫长的过程，因为它会在本地构建整个平台。上述其他选项要快得多！） - :coffee: 等待时间… 即使您使用了预构建的 Docker 镜像，我们的 API 在首次 Docker Compose 运行期间向数据库填充测试数据也可能需要一些时间。 注意事项： - 虽然演示 docker-compose.demo.yml 运行最少的容器（API、Web UI 和 DB），但其他 Docker Compose 文件运行多个基础设施依赖项（见下方完整列表）。 - 您也可以使用命令 docker-compose -f docker-compose.infra.yml up -d 仅运行基础设施依赖项（不包含我们的 API/Web 容器）。我们已在主 docker compose 文件中使用 include 来实现。 - 您可以在 docker-compose up 命令中添加类似 --env-file .env.something 的内容，指示 Docker Compose 使用包含您自定义设置的特定 .env.something 文件 除了 Gauzy，上述用于生产环境（docker-compose.yml）和构建（docker-compose.build.yml）的 Docker Compose 命令还将运行以下基础设施组件： - PostgreSQL (https://www.postgresql.org) - 主数据库。 - Pgweb (https://github.com/sosedoff/pgweb) - PostgreSQL 数据库的跨平台客户端，可在 访问。 - OpenSearch (https://github.com/opensearch-project) - 搜索引擎。 - OpenSearch Dashboards (https://github.com/opensearch-project) - 搜索引擎仪表板，可在 访问。默认用户名：admin，密码：Gauzy_password_123 - Dejavu (https://github.com/appbaseio/dejavu) - OpenSearch 的 Web UI，可在 访问。 - MinIO (https://github.com/minio/minio) - 多云 ☁️ 对象存储（兼容 AWS S3）。 - Jitsu (https://github.com/jitsucom/jitsu) - Jitsu 是一个开源的 Segment 替代品（数据摄入引擎）。 - Redis (https://github.com/redis/redis) - 内存数据存储/缓存（也被 Jitsu 使用）。 - Cube (https://github.com/cube-js/cube) - “语义层”，用于报告、仪表板、分析和其他 BI 相关功能，UI 可在 访问。 - Zipkin (https://github.com/openzipkin/zipkin) - 分布式追踪系统。 ### 手动构建与运行的快速开始 #### 必需 - 安装 NodeJs (https://nodejs.org/en/download) LTS 版本或更高版本（例如 22.x 或 24.x）。 - 安装 Yarn (https://github.com/yarnpkg/yarn) v1.22.x（如果您没有），使用 npm i -g yarn。 - 使用命令 yarn bootstrap 安装 NPM 包并引导解决方案。 - 如果您需要进行代码更改（并推送到 Git 仓库），请运行 yarn prepare:husky。 - 在用于本地运行的 .env.local (https://github.com/ever-co/ever-gauzy/blob/develop/.env.local) 中调整设置。 - 或者，您可以将 .env.sample (https://github.com/ever-co/ever-gauzy/blob/develop/.env.sample) 复制到 .env 并更改其中的默认设置，例如数据库类型、名称、用户名、密码等。 - 使用单个命令运行 API 和 UI：yarn start。 - 在浏览器中打开 Gauzy UI（API 在 运行）。 - 使用邮箱 [email protected] 和密码：admin 登录超级管理员用户。 - 使用邮箱 [email protected] 和密码：12345678 登录员工用户。 - 享受！ 注意事项： - 在首次 API 启动期间，如果未找到用户，数据库将自动填充最少的初始数据集。 - 您可以随时手动运行种子数据（例如，如果您更改了实体架构），使用 yarn seed 命令重新初始化数据库（警告：对生产环境不安全！）。 - 可以使用 yarn seed:all 生成极其大量的测试数据用于演示/测试（警告：大约需要 10 分钟完成）。 #### 可选/生产环境建议 - 可选（生产环境建议）安装并运行 PostgreSQL (https://www.postgresql.org) 14 或更高版本（生产环境建议使用 16.x）。注意：其他数据库可以在 TypeORM / MikroORM / Knex 中手动配置。默认数据库设置为 SQLite（仅建议用于测试/演示目的）。 - 可选（生产环境建议）安装并运行 Redis (https://github.com/redis/redis)。注意：平台将使用内存缓存策略而不是分布式策略运行（仅建议用于测试/演示目的）。但请注意，Jitsu 需要 Redis。 - 可选（生产环境建议）安装并运行 OpenSearch (https://github.com/opensearch-project)。注意：平台将使用数据库内置的搜索功能运行（仅建议用于测试/演示目的）。 - 可选（生产环境建议）安装并运行 MinIO (https://github.com/minio/minio) 或 LocalStack (https://github.com/localstack/localstack)。注意：平台将使用基于本地文件系统的存储运行，无需 MinIO / LocalStack 或其他兼容 S3 的存储（仅建议用于测试/演示目的）。