开发指南
开发工具及相关软件
| 软件 | 版本 | 备注 |
|---|---|---|
| JDK | 17 + | JAVA运行及开发工具包 |
| Node.js | v 20 LTS + | Node.js开发工具包 |
| eclipse-jee | 2025-06 + | 推荐JAVA开发工具 |
| Visual Studio Code | Version 1.66 + | 推荐前端开发工具 |
| MySQL | 8.4.0 + | 数据库服务器 |
| Gradle | 8.8+ | 代码构建 |
| Tomcat/tomcat-embed | 10 + | 应用服务器 |
程序目录
| JinBooks | 一级目录 | 二级目录 | 三级目录 | 说明 |
|---|---|---|---|---|
| README.md | 关于JinBooks项目介绍 | |||
| LICENSE | Apache License v2许可证 | |||
| CHANGELOG.md | 版本发布记录描述 | |||
| images | 图片 | |||
| jinbooks | jinbooks java工程 | |||
| jinbooks-commons | 公共包 | |||
| jinbooks-authn-core | 认证核心包 | |||
| jinbooks-authn-provider | 认证提供者 | |||
| jinbooks-common | 通用包 | |||
| jinbooks-crypto | 加解密 | |||
| jinbooks-core | 核心实体 | |||
| jinbooks-persistence | 数据库持久层 | |||
| jinbooks-starter | 公共starter | |||
| jinbooks-starter-captcha | 图像验证码starter | |||
| jinbooks-starter-ip2location | ip地址转换starter | |||
| jinbooks-starter-oss | 对象存储starter | |||
| jinbooks-starter-otp | 一次性口令starter | |||
| jinbooks-starter-sms | 手机短信starter | |||
| jinbooks-starter-web | 后端web公共starter | |||
| jinbooks-starter-xss | XXS防控starter | |||
| jinbooks-web | web后端java工程 | |||
| jinbooks-ui | web前端 | |||
| sql | 数据库MYSQL脚本,GA版本对应SQL |
开发环境应用启动
后端java web项目启动
在开发工具导入jinbooks目录
com.jinbooks.JinBooksApplication
前端jinbooks-ui
开发工具jinbooks-ui目录
1) 安装依赖
npm install
2) 启动开发服务器
npm run dev
3) 开发服务器将在本地启动，默认地址通常为：
http://localhost:3154
4) 构建与部署
4.1) 构建生产版本
npm run build
4.2) 部署到服务器
将 dist 目录中的文件上传至你的服务器，并配置相应的 Web 服务（如 Nginx）。
问题排查
若运行或构建过程中出现问题，请尝试以下操作：
-
确保已正确安装 Node.js 和 npm
-
检查网络连接，确保可以正常访问 npm 仓库
-
清理缓存后重新安装依赖：
npm cache clean --force npm install -
查看控制台错误信息并定位问题
如仍未解决，请提交 Issue 或联系维护者。
清理缓存
如果需要清理 npm 缓存，可执行以下命令：
npm cache clean --force