schulcloud-calendar

日历API

Schul-Cloud API要求

Node CalDAV模块研究

未来工作

概述

schulcloud-calendar是Schul-Cloud环境中使用的日历服务，提供完整的日历API接口，遵循Schul-Cloud API规范要求。该服务基于Node.js开发，使用PostgreSQL数据库存储数据，包含对CalDAV模块的研究与集成，支持日历数据的创建、查询、更新和删除等功能，适用于教育机构内部的日历管理需求。

设置

安装

本安装指南要求PostgreSQL/bin/*文件夹可通过shell/cmd访问（检查环境变量）。可通过psql --version等命令验证功能。

1. 克隆仓库
2. 安装并启动PostgreSQL，安装过程中设置并记住postgres用户密码
3. 创建无密码用户node：createuser -U postgres --superuser --login node
4. 创建名为schulcloud_calendar的数据库：createdb -U postgres schulcloud_calendar
5. 连接数据库：psql -d schulcloud_calendar -U postgres（提示符将变为schulcloud_calendar=#）
6. 授予用户数据库的所有权限：grant all privileges on database schulcloud_calendar TO node;（反馈应为：GRANT）
7. 安装uuid-ossp扩展：CREATE EXTENSION "uuid-ossp";（反馈应为：CREATE EXTENSION）
8. 退出psql解释器（Ctrl+C或打开新命令提示符）并运行npm install
9. 导入数据库数据：详见下文
10. 运行节点：
    • 生产环境：npm start
    • 本地Unix环境：npm run start_local
    • 本地Windows环境：npm run start_local_win

替代安装说明：日历设置

示例数据库数据

若命令出现fe_sendauth: no password supplied错误，编辑[安装目录]\data\pg_hba.conf并将所有行的METHOD设置为trust。

1. 创建表：psql -U node -d schulcloud_calendar -a -f schema.sql
2. 插入示例数据：psql -U node -d schulcloud_calendar -a -f example_data.sql

测试

1. 创建名为schulcloud_calendar_test的数据库并按上述步骤设置
2. 创建表：psql -U node -d schulcloud_calendar_test -a -f schema.sql
3. 运行测试：npm test