Amper 项目使用教程

Amper 项目使用教程

amperAmper - a tool for project configuration with a focus on the developer experience and the IDE support项目地址:https://gitcode.com/gh_mirrors/am/amper

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

Amper 项目的目录结构如下：

amper/
├── settings.gradle.kts
├── build.gradle.kts
├── gradle.properties
├── README.md
├── .github/
│   └── workflows/
├── docs/
│   └── ...
├── examples/
│   └── ...
├── src/
│   ├── main/
│   │   ├── kotlin/
│   │   │   └── ...
│   │   └── resources/
│   │       └── ...
│   └── test/
│       ├── kotlin/
│       │   └── ...
│       └── resources/
│           └── ...
└── ...

目录结构介绍

• settings.gradle.kts: Gradle 设置文件，用于配置项目的基本信息和模块。
• build.gradle.kts: 主构建文件，包含项目的依赖、插件和其他构建配置。
• gradle.properties: Gradle 属性文件，用于设置构建系统的属性。
• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• .github/: GitHub 配置目录，包含 CI/CD 工作流等配置文件。
• docs/: 文档目录，包含项目的详细文档和教程。
• examples/: 示例目录，包含项目的示例代码和项目结构。
• src/: 源代码目录，包含项目的主要代码和资源文件。
  • main/: 主代码目录，包含项目的业务逻辑代码。
    • kotlin/: Kotlin 代码目录。
    • resources/: 资源文件目录。
  • test/: 测试代码目录，包含项目的测试代码和资源文件。
    • kotlin/: 测试代码目录。
    • resources/: 测试资源文件目录。

2. 项目的启动文件介绍

Amper 项目的启动文件主要是 settings.gradle.kts 和 build.gradle.kts。

settings.gradle.kts

该文件用于配置项目的基本信息和模块，例如：

rootProject.name = "amper"
include(":core", ":examples")

build.gradle.kts

该文件是主构建文件，包含项目的依赖、插件和其他构建配置，例如：

plugins {
    id("org.jetbrains.kotlin.jvm") version "1.5.31"
}

repositories {
    mavenCentral()
}

dependencies {
    implementation(kotlin("stdlib"))
    testImplementation("org.junit.jupiter:junit-jupiter-api:5.7.0")
    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.7.0")
}

3. 项目的配置文件介绍

Amper 项目的配置文件主要包括 gradle.properties 和 module.yaml。

gradle.properties

该文件用于设置构建系统的属性，例如：

org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
org.gradle.parallel=true

module.yaml

该文件是 Amper 模块配置文件，用于定义项目的构建配置，例如：

# Produce a JVM application
product: jvm/app

以上是 Amper 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 Amper 项目。

amperAmper - a tool for project configuration with a focus on the developer experience and the IDE support项目地址:https://gitcode.com/gh_mirrors/am/amper