Someday 项目使用教程
1. 项目目录结构及介绍
Someday 项目是一个基于 Google Apps Script 的开源日程安排工具,它允许用户通过 Gmail 账户管理日程。项目使用现代技术栈,包括 React、TypeScript、Shadcn/UI 和 Vite。以下是项目的目录结构及其说明:
someday/
├── backend/ # 后端代码目录
│ ├── src/ # 源代码
│ ├── .claspignore # clasp 忽略文件
│ ├── .gitignore # git 忽略文件
│ ├── package-lock.json # 包锁定文件
│ └── package.json # 包管理文件
├── frontend/ # 前端代码目录
│ ├── src/ # 源代码
│ ├── .gitignore # git 忽略文件
│ ├── package-lock.json # 包锁定文件
│ └── package.json # 包管理文件
├── LICENSE.md # 许可证文件
├── README.md # 项目说明文件
├── appsscript.json # Google Apps Script 配置文件
├── build.sh # 构建脚本
├── deploy.sh # 部署脚本
├── deployments.sh # 列出部署脚本
├── undeployall.sh # 取消部署所有版本脚本
└── ...
backend/
: 包含后端逻辑,使用 TypeScript 编写,并且包含与 Google Apps Script 交互的代码。frontend/
: 包含前端界面,使用 React 和 Vite 构建的用户界面。LICENSE.md
: 项目的 MIT 许可证。README.md
: 提供项目的总体介绍和如何开始使用的信息。appsscript.json
: 定义 Google Apps Script 项目的配置。build.sh
,deploy.sh
,undeployall.sh
,deployments.sh
: 脚本文件,用于构建、部署和管理项目的不同阶段。
2. 项目的启动文件介绍
对于前端,启动文件是 frontend/
目录下的 package.json
中的命令。以下是启动前端开发服务器的命令:
"scripts": {
"dev": "vite"
}
通过运行 npm run dev
命令,你可以启动开发服务器,并在本地开发环境中查看前端界面。
对于后端,启动文件是 backend/
目录下的 package.json
中的命令。使用 clasp
命令来登录、创建、部署和打开 Apps Script 项目。
3. 项目的配置文件介绍
项目的配置主要集中在后端的 backend/src/app.ts
文件中,以下是该文件中的关键配置:
const CALENDAR = "primary"; // 使用的主要日历
const TIME_ZONE = "America/New_York"; // 时区设置
const WORKDAYS = [1, 2, 3, 4, 5]; // 工作日
const WORKHOURS = { start: 9, end: 13 }; // 工作时间
const TIMESLOT_DURATION = 30; // 时间槽时长(分钟)
这些配置用于自定义日历的可用性设置。此外,Google Apps Script 的项目设置也可以在 Apps Script 编辑器中进行配置,例如添加额外的日历或设置脚本属性。
请根据这些配置指南来调整项目以满足你的需求。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考