Jarboot 项目使用教程
1. 项目的目录结构及介绍
Jarboot 项目的目录结构如下:
jarboot/
├── LICENSE
├── README.md
├── README_CN.md
├── SECURITY.md
├── pom.xml
├── src/
│ ├── main/
│ │ ├── java/
│ │ └── resources/
│ └── test/
│ ├── java/
│ └── resources/
└── startup.sh
目录结构介绍
LICENSE
: 项目许可证文件。README.md
和README_CN.md
: 项目说明文档,分别提供英文和中文版本。SECURITY.md
: 项目安全相关说明。pom.xml
: Maven 项目配置文件。src/
: 源代码目录,包含主代码和测试代码。startup.sh
: 项目启动脚本。
2. 项目的启动文件介绍
Jarboot 项目的启动文件是 startup.sh
。该脚本用于启动 Jarboot 服务。
启动文件介绍
startup.sh
: 这是一个 shell 脚本,用于在 Unix/Linux 系统上启动 Jarboot 服务。在 Windows 系统上,可以使用相应的命令行启动。
启动步骤
- 确保系统上已安装 JDK 17+ 和 Node.js 16+。
- 在项目根目录下执行以下命令:
sh startup.sh
- 启动后,可以通过浏览器访问
http://127.0.0.1:9899
进入 Jarboot 的登录页面。
3. 项目的配置文件介绍
Jarboot 项目的配置文件主要位于 src/main/resources
目录下,包括 application.properties
和 application-dev.properties
等。
配置文件介绍
application.properties
: 主配置文件,包含项目的核心配置。application-dev.properties
: 开发环境配置文件,用于开发环境下的配置。
配置文件示例
# application.properties
server.port=9899
spring.profiles.active=dev
# application-dev.properties
logging.level.root=DEBUG
配置项说明
server.port
: 指定 Jarboot 服务的端口号,默认为 9899。spring.profiles.active
: 指定激活的配置文件,如dev
表示开发环境。logging.level.root
: 日志级别配置,DEBUG
表示调试级别。
通过以上配置文件,可以灵活地调整 Jarboot 的运行参数,以适应不同的开发和部署需求。