# mirage-document

**Repository Path**: shacocloud/mirage-document

## Basic Information

- **Project Name**: mirage-document
- **Description**: mirage 的文档仓库
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://mirage.shacocloud.cc/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-06-14
- **Last Updated**: 2023-06-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 介绍

基于 vertx 构建响应式编程框架，支持 kotlin，致力于让响应式编程变得更简单

仓库地址：https://gitee.com/shacocloud/mirage

文档地址：https://mirage.shacocloud.cc/

## 安装

在你的pom中添加以下依赖管理配置

```xml
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>cc.shacocloud</groupId>
                <artifactId>mirage-dependencies</artifactId>
                <version>${mirage.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
```

如果你需要使用 SNAPSHOT 相关版本，请使用以下存储库（SNAPSHOT 版本不提交到中央库）：

```xml
    <repositories>
        <repository>
            <snapshots>
                <enabled>true</enabled>
                <updatePolicy>always</updatePolicy>
                <checksumPolicy>warn</checksumPolicy>
            </snapshots>
            <id>ossrh</id>
            <name>ossrh</name>
            <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
        </repository>
    </repositories>
```

稳定版本：https://central.sonatype.com/artifact/cc.shacocloud/mirage/2.0.1/versions

快照版本：https://s01.oss.sonatype.org/content/repositories/snapshots/cc/shacocloud/mirage/

## 使用

在你的pom中添加以下依赖

```xml
        <dependency>
            <groupId>cc.shacocloud</groupId>
            <artifactId>mirage-starter</artifactId>
        </dependency>
```

编写应用main方法，启动应用

**java**

```java
@MirageBootApplication
public class Application {

    public static void main(String[] args) {
        MirageApplication.run(Application.class,args);
    }

}
```

**Kotlin**

```kotlin
@MirageBootApplication
class Application

fun main(args: Array<String>) {
    MirageApplication.run(Application::class.java, *args)
}
```

如果你使用`kotlin`那么你还需要添加以下依赖，以获得对 `kotlin`的支持

```xml
<dependency>
    <groupId>cc.shacocloud</groupId>
    <artifactId>mirage-kotlin</artifactId>
</dependency>
```