Investbook 开源项目教程

Investbook 开源项目教程

investbook Оценка эффективности инвестиций с учетом комиссий, налогов (удержанных и ожидающихся), дивидендов и купонов. 项目地址: https://gitcode.com/gh_mirrors/in/investbook

1. 项目的目录结构及介绍

Investbook 项目的目录结构如下：

investbook/
├── docs/
├── src/
├── .gitattributes
├── .gitignore
├── LICENSE
├── README-en.md
├── README.md
├── mvnw
├── mvnw.cmd
└── pom.xml

目录结构介绍

• docs/: 存放项目的文档文件，包括用户手册、API 文档等。
• src/: 项目的源代码目录，包含所有的 Java 源文件和资源文件。
• .gitattributes: Git 属性文件，用于定义文件的属性。
• .gitignore: Git 忽略文件，用于指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目的开源许可证文件，本项目使用 AGPL-3.0 许可证。
• README-en.md: 英文版的项目介绍文件。
• README.md: 项目介绍文件，包含项目的基本信息、安装和使用说明。
• mvnw: Maven 包装器脚本，用于在 Unix 系统上运行 Maven 命令。
• mvnw.cmd: Maven 包装器脚本，用于在 Windows 系统上运行 Maven 命令。
• pom.xml: Maven 项目的配置文件，定义了项目的依赖、插件和其他构建配置。

2. 项目的启动文件介绍

Investbook 项目的启动文件主要是通过 Maven 进行管理的。项目的启动过程通常包括以下几个步骤：

1. 编译项目: 使用 mvn compile 命令编译项目源代码。
2. 打包项目: 使用 mvn package 命令将项目打包成可执行的 JAR 文件。
3. 运行项目: 使用 java -jar target/investbook.jar 命令启动项目。

启动文件介绍

• mvnw: 这是一个 Maven 包装器脚本，用于在 Unix 系统上运行 Maven 命令。通过运行 ./mvnw clean install 可以编译、测试和打包项目。
• mvnw.cmd: 这是 Maven 包装器脚本，用于在 Windows 系统上运行 Maven 命令。通过运行 mvnw.cmd clean install 可以编译、测试和打包项目。
• pom.xml: 这是 Maven 项目的配置文件，定义了项目的依赖、插件和其他构建配置。通过 Maven 命令可以启动项目。

3. 项目的配置文件介绍

Investbook 项目的配置文件主要包括 pom.xml 和 src/main/resources/application.properties。

pom.xml

pom.xml 是 Maven 项目的核心配置文件，定义了项目的依赖、插件和其他构建配置。以下是 pom.xml 的主要内容：

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.spacious-team</groupId>
    <artifactId>investbook</artifactId>
    <version>1.0.0</version>
    <packaging>jar</packaging>

    <dependencies>
        <!-- 项目依赖 -->
    </dependencies>

    <build>
        <plugins>
            <!-- 构建插件 -->
        </plugins>
    </build>
</project>

application.properties

application.properties 是 Spring Boot 项目的配置文件，用于配置应用程序的各种属性，如数据库连接、日志级别等。以下是 application.properties 的示例内容：

# 数据库配置
spring.datasource.url=jdbc:mysql://localhost:3306/investbook
spring.datasource.username=root
spring.datasource.password=secret

# 日志配置
logging.level.root=INFO

通过这些配置文件，可以灵活地配置和启动 Investbook 项目。

investbook Оценка эффективности инвестиций с учетом комиссий, налогов (удержанных и ожидающихся), дивидендов и купонов. 项目地址: https://gitcode.com/gh_mirrors/in/investbook