内容
# 时刻卫士
时刻卫士是一款可自行托管的倒计时服务,用于创建时区感知的定时器,将它们组织成项目和空间,并通过还原密钥同步和恢复定时器状态。该应用使用Next.js构建,并将项目、定时器、共享、通知出口记录、投递日志和推送订阅存储在PostgreSQL中。Redis仅通过与Upstash兼容的REST API用于速率限制。
## 快速开始
```bash
git clone https://github.com/CorgiCorner/tickward.git 时刻卫士
cd 时刻卫士
cp .env.example .env
docker compose up --build
```
打开 [http://localhost:3000](http://localhost:3000)。
## 功能特点
- 具有描述、图片、重复、归档/恢复和固定功能的时区感知定时器。
- 项目和空间,带有用于启用通知和共享定时器的本地过滤器。
- `/share/...`下的只读定时器共享链接。
- 可选的电子邮件代码帐户和匿名项目认领。
- 设备通知、全页闹钟和本地通知声音。
- 基于PostgreSQL的项目数据、共享记录、通知出口记录、投递日志、推送订阅记录和哈希公共API密钥。
## 文档
详细的设置、配置、API和代理文档位于文档站点:
- [自行托管指南](docs/site/guides/self-hosting.mdx)
- [API快速入门](docs/site/guides/api-quickstart.mdx)
- [MCP设置](docs/site/guides/mcp.mdx)
- [API参考](docs/site/api-reference.mdx)
- [代理使用](docs/site/guides/agent-usage.mdx)
## 许可证
时刻卫士在GNU Affero General Public License v3.0下发布。参见 [LICENSE](LICENSE)。
## 更新日志
发布说明在 [CHANGELOG.md](CHANGELOG.md) 中跟踪。
## 贡献
欢迎公开贡献。参见 [CONTRIBUTING.md](CONTRIBUTING.md) 以获取详细信息。