Google Calendar Hours 项目技术文档

1. 安装指南

环境要求

• Node.js 版本 >= 12.0.0
• npm 版本 >= 6.0.0

安装步骤

1. 克隆项目到本地：

   git clone https://github.com/aronwoost/google-calendar-hours.git
   

2. 进入项目目录：

   cd google-calendar-hours
   

3. 安装项目依赖：

   npm install
   

2. 项目的使用说明

本地运行

在项目目录下运行以下命令，启动本地开发服务器：

npm run dev

启动后，访问 http://localhost:3000 即可查看项目运行效果。

生产环境构建

1. 构建生产环境版本：

   npm run build
   

2. 启动生产环境服务器：

   npx serve@latest out
   

   启动后，访问 http://localhost:3000 即可查看生产环境下的项目运行效果。

3. 项目API使用文档

Google Calendar API 授权

项目使用 Google Calendar API 获取用户的日历和事件数据。用户需要通过 Google 授权流程，授予项目读取日历数据的权限。

数据处理

项目通过 Google Calendar API 获取用户的日历和事件数据后，会进行以下处理：

• 计算用户在指定时间范围内的日历活动时长。
• 支持按天、周、月、年、总时长或自定义时间范围进行过滤。

数据展示

项目会将处理后的数据以图表和表格的形式展示，用户可以直观地查看自己在不同时间范围内的日历活动时长。

4. 项目安装方式

通过 npm 安装

项目可以通过 npm 进行安装，具体步骤如下：

1. 在项目目录下运行以下命令，安装项目依赖：

   npm install
   

2. 启动本地开发服务器：

   npm run dev
   

通过 Docker 安装（可选）

项目支持通过 Docker 进行安装，具体步骤如下：

1. 构建 Docker 镜像：

   docker build -t google-calendar-hours .
   

2. 运行 Docker 容器：

   docker run -p 3000:3000 google-calendar-hours
   

   启动后，访问 http://localhost:3000 即可查看项目运行效果。

5. 测试

项目包含单元测试，可以通过以下命令运行测试：

npm test

6. 其他说明

• 项目使用 sessionStorage 存储用户的授权数据，关闭浏览器窗口/标签后，所有授权数据将被删除。
• 项目仅具有对用户日历数据的只读权限，不会保存或泄露用户的日历数据。

通过以上文档，您应该能够顺利安装、使用和了解 Google Calendar Hours 项目。如有任何问题，请参考项目的 GitHub Wiki 或提交 Issue。