NPClassworks

面向班级大屏、教师和学生的统一作业板
由 星火动力（NOVARK POWER） 维护

NPClassworks 基于 Classworks 深度改造，针对高中行政班、选科定班和走班教学并存的实际场景设计。前端是一套 Vue 3 + Vuetify 3 PWA，需要与 NPClassworksKV 后端配合使用。

当前版本：v1.1.0 · Ikuyo（喜多郁代）。

主要能力

• 学生、教师、班级大屏三种界面和首次使用引导
• 行政班、走班教学班和特殊定班规则统一建模
• 作业与通知实时同步，支持教师认证、修订历史和不可删除备份
• 大屏快速录入、学校级快捷词与快捷截止时间
• 教师一次登录管理多个行政班和走班教学班
• 大屏独立账号、设备绑定、显示设置和课堂工具
• 通知提示音、系统通知、噪声监测和麦克风选择
• 适配 1080P、2K、4K 班级一体机

技术栈

• Vue 3、Vuetify 3、Pinia、Vue Router
• Vite 5、PWA / Workbox
• Socket.IO 实时同步
• HTTP API、PostgreSQL 服务端数据与大屏离线队列

本地开发

环境要求：Node.js 22+、pnpm 10+。完整联调还需要本地运行 NPClassworksKV。

git clone https://github.com/tempChanghong/NPClassworks.git
cd NPClassworks
pnpm install
pnpm run dev

开发服务器默认监听 http://localhost:3031。

pnpm test
pnpm run build
pnpm run lint

测试范围、流程测试运行方式与边界见 前端自动化测试。

部署

页面的 canonical、Open Graph 地址及分享图片由 vite.config.mjs 统一生成，默认前端站点为 https://newfires.top。自建部署可在构建环境或 .env.production.local 中设置 VITE_SITE_ORIGIN=https://your-school.example；Docker 构建使用 --build-arg VITE_SITE_ORIGIN=https://your-school.example（Compose 对应 frontend.build.args.VITE_SITE_ORIGIN）。它必须是仅含协议、主机及可选端口的 HTTP(S) 地址，不接受路径、查询参数或账号密码。

该变量表示用户访问的前端站点，与 VITE_DEFAULT_KV_SERVER 指定的 API 服务地址不同；修改后需要重新构建并部署前端，容器运行时设置不会改写已生成的 HTML。robots 继续使用 noindex, follow。

生产环境建议让前后端保持同源，由反向代理统一提供 HTTPS，并将 /api、/accounts、/socket.io、健康检查和指标路径转发至 NPClassworksKV。部署前请先阅读后端仓库的生产配置说明并执行数据库迁移。

联合生产栈由同级的 NPClassworksKV 仓库统一启动，必须显式加载生产环境文件：

cd ../NPClassworksKV
docker compose --env-file deploy/.env.production up -d --build

项目关系与致谢

NPClassworks 是 Classworks 的衍生项目，不是 Classworks 官方版本。感谢 Classworks 原作者和所有上游贡献者；本项目保留上游版权与许可证声明。

项目维护与部署支持：星火动力（NOVARK POWER）。

品牌素材位于 images；反色版本用于深色背景，请勿改变图形比例。

开源协议

本项目遵循 GNU AGPL-3.0。分发或部署修改版本时，请同时遵守上游项目和本项目的许可证要求。