# plume-code

**Repository Path**: dxmonster/plume-code

## Basic Information

- **Project Name**: plume-code
- **Description**: an awesome code generator application 
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 34
- **Created**: 2021-07-01
- **Last Updated**: 2022-09-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Plume-Code

一个简单易用且功能强大的代码生成器(Java & ElementUI),熟练使用你就是CURD代码挖掘机！！！

PlumeCode 不仅简单、而且强大

- 支持多数据库Mysql、H2（SqlServer、Oracle、PostgreSQL TBD...）
- 支持多种持久层框架MybatisPlus、Mybatis、Jpa、tk-Mybatis (Hibernate TBD...)
- 一键下载拥有portal、controller、service、repository、mapper、dto、entity、vo、query、mapper.xml等前后端代码
- 良好的项目结构，让二次开发变得像喝水一样简单

## 快速开始

### 下载文件

[plume-code-starter-0.0.1.jar](https://gitee.com/yansheng/plume-code/raw/main/assemble/plume-code-starter-0.0.1.jar)

### 启动项目

​	java -Dspring.profiles.active=prod -jar plume-code-starter-0.0.1.jar
![start](/image/0.png)

### 功能简介

- 打开网页
  http://localhost:8844/web/index.html
- 数据库配置
  ![start](/image/1.png)
  ![database](/image/3.png)
- 生成代码
  ![generator](/image/2.png)
- 代码预览
  ![preview](/image/4.png)

## 生成代码示例

[plume-code-sample](https://gitee.com/yansheng/plume-code-sample)

## 生成代码结构

### 三层架构

- controller layer(controller、vo、query)
- servicer layer(service、serviceImpl、dto)
- dao layer(repository/mapper/dao、repositoryImpl/daoImpl、entity)
- ![project layer](/image/6.png)
- ![package](/image/7.png)

### 前端框架
    由于前端代码公司间差异比较大，这里只是做了ElementUI的示例，如有需要，可根据实际前端技术选型，做二次开发集成
- [d2admin](https://d2.pub/zh/)
- [element-ui](https://element.eleme.cn/2.15/#/zh-CN)

## Road Map

### 0.0.1 version

- 支持 mysql、h2 --done
- 支持 element-ui --done
- 支持mybatis、mybatis-plus、jpa --done
- 支持预览代码、获取代码 --done

### 0.0.2 version

- 支持联合主键
- 支持sqlserver、oracle、PostgreSQL
- 支持hibernate、tk-Mybatis
- 支持Query 后缀配置
- 支持VO 后缀配置
- 支持DTO后缀配置
- 支持Entity后缀配置

### 0.0.3 version

- 支持docker部署（部署plume-code）
- 支持docker compose 部署（含所有数据库类型）

### 0.0.4 version

- 支持包路径修改
- 支持swagger、lombok
- 配置基于xml、yml配置
- 编写dtd约束文件
- 用户自定义配置文件



## 项目结构

 ![framework](/image/5.png)


## 二开说明

TBD...