You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
slms/docs/QUICK_START.md

4.6 KiB

SLMS 快速开始指南

5 分钟快速上手 SLMS 智能图书管理系统


🚀 快速启动

1 初始化数据库

init_database.bat

2 选择应用启动

CLI 应用(命令行)

run_cli.bat

GUI 应用(桌面应用)

run_gui.bat

Web 应用(浏览器)

run_web.bat

访问: http://localhost:8080

Android 应用(手机/模拟器)

run_android.bat

选择选项 5完整流程


📚 主要功能

图书管理

  • 查看图书列表
  • 添加新图书
  • 搜索图书
  • 更新图书信息

借阅管理

  • 借阅图书
  • 归还图书
  • 查看借阅记录
  • 续借图书

数据统计

  • 图书总数
  • 借阅统计
  • 可借图书数量

🧪 运行测试

测试所有应用

run_all_tests.bat

测试单个应用

run_tests.bat        # CLI 测试
run_gui_tests.bat    # GUI 测试
run_web_tests.bat    # Web 测试

🛠️ 常用命令

数据库管理

init_database.bat    # 初始化数据库(首次使用)
reset_database.bat   # 重置数据库(清空数据)

项目维护

cleanup_project.bat  # 清理临时文件和缓存

Web 应用打包

package_web.bat      # 打包 Web 应用为 JAR

📖 文档导航

新手必读

  1. README.md - 项目介绍
  2. PROJECT_OVERVIEW.md - 项目概览
  3. START_APPLICATIONS.md - 详细启动指南

开发者文档

  1. PROJECT_STRUCTURE.md - 项目结构
  2. DATABASE_README.md - 数据库设计
  3. PROJECT_STATUS.md - 项目状态

测试报告

  1. CLI_TEST_REPORT.md - CLI 测试
  2. GUI_TEST_REPORT.md - GUI 测试
  3. WEB_TEST_REPORT.md - Web 测试
  4. ANDROID_TEST_REPORT.md - Android 测试

常见问题

Q: 首次使用需要做什么?

A: 运行 init_database.bat 初始化数据库

Q: 如何重置数据?

A: 运行 reset_database.bat 重置数据库

Q: Web 应用端口被占用?

A: 修改 src/main/resources/application.properties 中的 server.port

Q: GUI 应用无法启动?

A: 确保安装了 JavaFX或使用 mvn javafx:run 启动

Q: Android 应用如何安装?

A: 运行 run_android.bat 选择选项 5完整流程

Q: 如何清理项目?

A: 运行 cleanup_project.bat 清理临时文件


🎯 快速测试流程

1. 初始化

init_database.bat

2. 测试 CLI

run_cli.bat
# 选择选项 1 查看图书列表
# 选择选项 0 退出

3. 测试 GUI

run_gui.bat
# 在窗口中浏览图书和借阅记录

4. 测试 Web

run_web.bat
# 打开浏览器访问 http://localhost:8080

5. 测试 Android

run_android.bat
# 选择选项 5完整流程
# 在模拟器中查看应用

📊 数据说明

默认数据

  • 图书: 27 本CLI/GUI/Web或 15 本Android
  • 用户: 10 个
  • 借阅记录: 16 条CLI/GUI/Web或 4 条Android

数据位置

  • 数据库文件: library.db
  • 所有应用共享: CLI、GUI、Web 共享同一数据库
  • Android 独立: Android 使用本地 SharedPreferences

🔧 环境要求

必需

  • Java: JDK 21
  • Maven: 3.6+CLI/GUI/Web
  • Gradle: 8.5+Android

可选

  • JavaFX: 17GUI 应用)
  • Android SDK: 34Android 应用)
  • Android 模拟器: pixel_5_-_api_34

💡 提示

性能优化

  • 首次启动可能需要下载依赖,请耐心等待
  • Web 应用首次启动需要编译,约需 30 秒
  • Android 应用首次构建需要下载依赖,约需 2-3 分钟

数据同步

  • CLI、GUI、Web 三个应用共享同一个数据库
  • 在任一应用中修改数据,其他应用会同步更新
  • Android 应用使用独立的本地存储

故障排除

  • 如遇问题,先运行 cleanup_project.bat 清理项目
  • 然后重新运行 init_database.bat 初始化数据库
  • 最后重新启动应用

🎉 开始使用

现在你已经了解了基本操作,可以开始使用 SLMS 了!

推荐流程:

  1. 初始化数据库
  2. 先试用 CLI 应用熟悉功能
  3. 再试用 GUI 应用体验界面
  4. 最后试用 Web 应用和 Android 应用

祝使用愉快! 🚀


需要帮助? 查看完整文档: README.md