Team-Nav 项目安装与使用教程
1. 项目目录结构及介绍
team-nav/
├── bin/
│ ├── start.sh
│ └── stop.sh
├── config/
│ └── application.yml
├── database/
├── ext-resources/
├── logs/
├── src/
│ ├── main/
│ │ ├── java/
│ │ └── resources/
│ └── test/
│ ├── java/
│ └── resources/
├── target/
│ └── team-nav.jar
└── README.md
目录结构说明:
- bin/: 包含项目的启动和停止脚本。
- config/: 包含项目的配置文件
application.yml
。 - database/: 用于存放数据库文件。
- ext-resources/: 用于存放额外的资源文件,如自定义图标、网址文件、附件等。
- logs/: 用于存放日志文件。
- src/: 包含项目的源代码,分为
main
和test
两个部分。 - target/: 包含编译后的可执行 JAR 文件
team-nav.jar
。 - README.md: 项目的说明文档。
2. 项目启动文件介绍
启动脚本 start.sh
start.sh
是项目的启动脚本,位于 bin/
目录下。执行该脚本可以启动项目。
./bin/start.sh
停止脚本 stop.sh
stop.sh
是项目的停止脚本,位于 bin/
目录下。执行该脚本可以停止项目。
./bin/stop.sh
3. 项目配置文件介绍
配置文件 application.yml
application.yml
是项目的主要配置文件,位于 config/
目录下。该文件包含了项目的各种配置项,如数据库连接、日志路径、端口等。
配置文件示例:
server:
port: 8080
spring:
datasource:
url: jdbc:h2:file:./database/team-nav
username: sa
password:
logging:
file: ./logs/team-nav.log
配置项说明:
- server.port: 指定服务器的端口号。
- spring.datasource: 配置数据库连接信息,包括 URL、用户名和密码。
- spring.logging.file: 指定日志文件的存储路径。
通过修改 application.yml
文件,可以自定义项目的各种配置。