Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/1340691923/ev-tools


https://github.com/1340691923/ev-tools

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README 

        
#  ev工具箱



### ev工具箱是用于管理elasticsearch6,7,8版本的ElasticView插件



* 支持sql转换成dsl语法

* 更方便的重建索引

* 任务管理

* 备份管理

* 可将查询内容下载为excel文件

* 可进行索引创建，映射创建，别名创建，索引删除等操作

* 支持版本 `6.x`,`7.x`,`8.x`

* 支持类似Navicat功能



```

二开本项目准备工作：



基座启动:

确保已经在开发插件的机器上启动ElasticView



环境配置:

golang版本 >= 1.20

node版本 >= 20.14.0



安装gowatch:

go install github.com/silenceper/gowatch@latest



安装辅助工具到项目根目录：

go build -o ev_plugin_zip .\cmd\ev_plugin_zip\main.go

go build -o ev_plugin_builder .\cmd\ev_plugin_builder\main.go



安装pnpm:

npm install -g pnpm



```



### 项目基础架构



```

-backend        后端项目目录

    -api        控制器层

    -dto        web请求结构

    -migrate    sqlite数据表版本控制模块

        -versions 存放各版本数据表结构升级回退

    -model      数据访问层

    -my_error   模板自定义异常包

    -response   模板自定义响应包

    -router     后端路由定义模块

    -vo         web响应结构

-cmd 

    -ev_plugin_builder  工具包 用于编译各操作系统（windows,linux,darwin）的二进制插件

    -ev_plugin_zip      工具包 用于打包项目源代码成zip

-frontend      前端项目目录

    -dist      前端最终打包文件

    -src

        -api   接口访问层

        -lang   语言包

        -layouts    默认布局

        -plugin_sdk 插件sdk

        -router     前端路由

        -views      页面文件

```



### plugin.json配置：



```json

{

  "developer": "xiaowenlong", //开发者名称

  "plugin_alias": "ev-tools", //插件id 也叫插件别名

  "plugin_name":"ev工具箱", //插件显示名称

  "frontend_debug": false, // 是否开启前端页面调试

  "version": "0.0.1",     //当前版本号

  "main_go_file": "main.go", // 后端 main.go文件位置

  "frontend_dev_port":7001, //前端项目启动端口

  "frontend_routes": [  //前端路由 与 routes中保持一致

    {

      "path": "hello-world", 

      "name": "HelloWorld",

      "meta": {

        "title": "HelloWorld",

        "icon": "el-icon-coin"

      }

    },

    {

      "path": "db-test",

      "name": "db-test",

      "meta": {

        "title": "操作数据库",

        "icon": "el-icon-coin"

      }

    }

  ],

  "backend_routes": [   //后端路由

    {

      "path": "/api/HelloWorld",  //接口访问路径

      "remark": "HelloWorld测试接口", //备注

      "needAuth": false       //是否需要鉴权

    }

  ]

}



```   



#### 后端插件开发



```

项目根目录执行:

1. go mod tidy

2. gowatch



```



#### 前端插件开发

```



重点：修改plugin.json 中 frontend_debug 为 true



1. cd frontend && pnpm i 



2. npm run dev



```



#### 前端插件打包

```



1. cd frontend && npm run build



```



#### 后端插件打包



```

重点：修改plugin.json 中 frontend_debug 为 false



项目根目录执行:

ev_plugin_builder



在dist目录会出现一个压缩包，解压后是各个不同操作系统的插件二进制，

按自己实际情况移动对应二进制文件至ElasticView的plugin文件夹中即可



```



### 后端插件打源码包



```



项目根目录执行:

ev_plugin_zip -source=需打包文件夹目录地址



```