初始化 XHChat 仓库与源码查阅许可
This commit is contained in:
commit
43687d5e7e
3 files changed
+67
No files matched your search
@@ -0,0 +1,7 @@
|
||||
node_modules/
|
||||
dist/
|
||||
.env
|
||||
*.exe
|
||||
*.log
|
||||
test-results/
|
||||
playwright-report/
|
||||
@@ -0,0 +1,29 @@
|
||||
XHChat 源码查阅许可协议 1.0
|
||||
|
||||
版权所有 © 2026 xhgit(XHChat 项目权利人)。保留所有未明确授予的权利。
|
||||
|
||||
一、适用范围
|
||||
|
||||
本协议适用于 XHChat 官方仓库公开的、由权利人有权许可的原创源代码、文档及随附材料。另有许可声明的第三方组件、依赖和素材适用各自的许可条款。
|
||||
|
||||
二、公开查阅
|
||||
|
||||
权利人允许公众免费在官方仓库查阅材料,并允许浏览器为显示内容而进行必要的临时复制。查阅许可为非独占、不可转让、不可再许可,仅限本人阅读和了解项目。
|
||||
|
||||
三、保留权利
|
||||
|
||||
在适用法律允许的范围内,未经权利人事先书面许可,不得下载或克隆以保留本地副本,不得修改、改编、翻译或制作衍生作品,也不得分叉、再分发、镜像、转授权、销售、编译、运行、部署或将材料用于其他项目。官方仓库提供的克隆、下载或分叉功能本身不构成额外许可。
|
||||
|
||||
权利人及其明确授权的维护者可以在授权范围内开发、修改、测试和发布 XHChat。公开查阅许可不授予 XHChat 名称、标志或其他商标的使用权。
|
||||
|
||||
四、禁止违法用途
|
||||
|
||||
不得以本协议项下的访问或查阅实施、促成或协助违反适用法律法规的活动,包括侵犯他人隐私或知识产权、诈骗、传播恶意软件以及未经授权访问他人系统或数据。其他用途仍须符合第二条和第三条的授权范围。
|
||||
|
||||
五、终止与法定权利
|
||||
|
||||
违反本协议时,本协议授予的权限自动终止。适用法律规定的强制性权利、著作权限制和例外不受本协议限制。
|
||||
|
||||
六、保证与责任
|
||||
|
||||
在适用法律允许的范围内,公开材料按现状提供。权利人不就适销性、特定用途适用性、完整性或无错误作出保证。依法不得排除或限制的责任仍依适用法律承担。
|
||||
@@ -0,0 +1,31 @@
|
||||
# XHChat
|
||||
|
||||
本仓库公开源码供查阅,修改、分发与部署需经权利人书面授权。禁止将查阅权限用于违法活动。详见 [XHChat 源码查阅许可协议](LICENSE)。
|
||||
|
||||
Windows 桌面端位于 `Desktop`,Web 客户端位于 `web`。当前版本实现用户名注册和登录、独立设备身份、设备查看与撤销、退出登录及经认证的实时连接。完整产品按 [阶段进度](docs/progress.md) 交付。
|
||||
|
||||
## 本地运行
|
||||
|
||||
环境需要 Docker Compose、Node.js 24 和 npm。首次启动时在仓库根目录执行以下 PowerShell 命令。已有 `.env` 时保留原配置。
|
||||
|
||||
```powershell
|
||||
if (-not (Test-Path .env)) {
|
||||
$xhchatPassword = [Convert]::ToHexString([Security.Cryptography.RandomNumberGenerator]::GetBytes(24)).ToLowerInvariant()
|
||||
(Get-Content .env.example -Raw).Replace('XHCHAT_DB_PASSWORD=', "XHCHAT_DB_PASSWORD=$xhchatPassword") | Set-Content .env
|
||||
}
|
||||
docker compose up -d --build --wait
|
||||
npm.cmd ci
|
||||
npm.cmd run build
|
||||
npm.cmd run desktop
|
||||
```
|
||||
|
||||
Web 客户端独立访问 [本机 Web](http://127.0.0.1:8080)。桌面端默认连接同一服务。两端以相同用户名和密码登录,各自生成设备身份。桌面端可通过 `XHCHAT_SERVER_URL` 指定 HTTPS 部署地址。
|
||||
|
||||
## 开发与部署
|
||||
|
||||
- [总体架构与目录](docs/architecture.md)
|
||||
- [数据库](docs/database.md) · [API](docs/api.md) · [部署](docs/deployment.md)
|
||||
- [加密协议](docs/encryption.md) · [音视频](docs/realtime-media.md) · [浏览器安全与威胁模型](docs/browser-security.md)
|
||||
- [进度与验收记录](docs/progress.md)
|
||||
|
||||
`npm run check` 执行双端类型检查。服务端需要 Go 1.27.4 或兼容的更新版本,在 `server` 内使用 `go test ./...`。本机 Compose 启动后,使用 `node --test tests/api.test.mjs` 运行 API 集成测试。Windows 上使用 `npm.cmd run build`、`npm.cmd run build -w Desktop` 和 `node --test tests/clients.test.mjs` 构建并运行 Edge 与 Electron 交叉测试。
|
||||
Reference in new issue
Block a user