使用文档

开发、构建与贡献

准备本地开发环境,构建项目并参与贡献

仓库结构

目录职责
password-xl-webVue 3、TypeScript、Vite 前端及 Electron 桌面端
password-xl-serviceSpring Boot 私有存储服务,当前要求 Java 25
官网独立仓库Next.js、Fumadocs、MDX,静态导出产品官网

前端开发

准备项目要求的 Node.js、Corepack 与 Yarn,进入前端目录后使用 Yarn。先阅读该版本的 package.json 与仓库贡献约定

cd password-xl-web
yarn install --immutable
yarn start

生产构建:

yarn build

桌面客户端请在目标操作系统上准备打包环境,并使用仓库提供的构建脚本

后端开发

安装 JDK 25,在服务目录中使用 Gradle Wrapper:

Linux / macOS
cd password-xl-service
./gradlew bootRun
Windows PowerShell
Set-Location password-xl-service
.\gradlew.bat bootRun
Windows CMD
cd password-xl-service
gradlew.bat bootRun

运行前配置独立的数据目录,避免使用正式密码库。配置方法见服务配置

参与贡献与许可证

通过 GitHub 提交问题或代码。提交前描述复现步骤、修改原因和验证结果,使用虚构测试数据,避免提交密钥、密码库和私有配置

项目使用 MPL-2.0。再分发与修改时保留适用的许可证和版权信息;具体义务以许可证原文为准