[English](README.md) | [简体中文](README-zh.md)

---
# 云原生应用脚手架

## 文档
- [如何自定义内容](docs/howToCustom-zh.md)
- [代码贡献](docs/CONTRIBUTING-zh.md)
- [常见问题](docs/faq-zh.md)
 
## 代码结构
这是一个源自于 Spring Initializr 构建的云原生应用脚手架项目，你可以直接体验该项目的功能通过 [start.aliyun.com](https://start.aliyun.com/) ，项目本身包含以下模块：
* initializer-generator: 脚手架生成项目模块，在其中`io.spring.start.site`目录下引用了部分 [start.spring.io](https://start.spring.io/) 的基础代码。
* initializer-page: 脚手架前端页面
* initializer-start: 脚手架启动、打包入口模块

## 基于源代码运行
请在本地 clone 该项目，并确保具备 Java 17 环境。

### 构建项目
由于前端是以源码的形式存储与本项目中，需要使用yarn进行编译后，成为当前项目的资源文件，才能被正确访问，在`cloud-native-app-initializer` 目录下执行：
```shell
mvn clean install
```
此步骤执行后，对项目模块进行编译构建。其中，编译后的前端文件，会被复制到 `initializer-page/target/classes/static` 目录下

### 启动项目
进入`initializer-start` 模块，执行以下命令启动应用：
```shell
mvn spring-boot:run
```
在浏览器中，输入 http://127.0.0.1:7001/bootstrap.html 即可使用脚手架项目进行工程构建。

## 基于镜像运行
在进行后续操作前，请确保相关环境已经安装 Docker。

### 拉取镜像
在本地命令行执行以下命令，拉取脚手架工程镜像：
```shell
docker pull registry.cn-hangzhou.aliyuncs.com/cloud-native-app-initializer/initializer:latest
```

### 启动容器
在本地命令行执行以下命令，启动脚手架容器：
```shell
docker run -it -p 127.0.0.1:7001:7001 registry.cn-hangzhou.aliyuncs.com/cloud-native-app-initializer/initializer:latest
```

## 项目License
该项目是一个采用 [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html) 的项目。