# ruov
**Repository Path**: wangjusanmu/ruov
## Basic Information
- **Project Name**: ruov
- **Description**: 基于ruoyi-vue3的cli工具,可快速构建系统。提供了内置命令,为开发者提供更加方便快捷的使用体验。
- **Primary Language**: Go
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-21
- **Last Updated**: 2025-05-07
## Categories & Tags
**Categories**: Uncategorized
**Tags**: Java, Vue, Go语言, SpringBoot
## README
Ruov Base Generate, 快速构建应用
# 简介 | Ruov
基于Ruoyi-Vue3搭建,使用`Cli(命令行)`快速搭建,提供命令行`快捷命令`,为开发者提供更加便捷的使用体验.
* 本工具前端基于 [Ruoyi-Vue3](https://github.com/yangzongzhuan/RuoYi-Vue3)
构建,配套后端 [RuoYi-Vue](https://gitee.com/y_project/RuoYi-Vue)。
* 命令行建设基于 [cobra](https://github.com/spf13/cobra/) 实现。
# 1. Ruov 命令行参数介绍
该框架创建与操作一切可基于命令行执行.
## init - 初始化新项目
该命令将在当前目录下建立ruov项目结构,根据数据库等信息建立Base code.
## mod-新增项目模块
在项目admin-api logic目录执行.该命令将根据选中数据新建模块。
## gen- 模块下生成基础代码
在项目根目录执行,可对当前项目选择的数据表,生成controller,service,mapper,domain结构代码
| 参数 | 默认值 | 说明 |
|:-----------------:|:----:|:--------------:|
| -c, --controller | true | 生成controller |
| -d, --dto | true | 生成dto |
| -m, --mapper | true | 生成mapper |
| -x, --mapperXml | true | 生成mapper xml |
| -p, --po | true | 生成po |
| -s, --service | true | 生成service |
| -i, --serviceImpl | true | 生成service impl |
| -v, --vo | true | 生成vo |
## git - 标准化的git commit push
在项目目录执行,提供标准化的消息提示.
```shell
Examples:
ruov git ...
提交当前目录: ruov git .
```
| 参数 | 默认值 | 说明 |
|:-----:|:-----:|:------:|
| --log | false | 查看提交历史 |
# 2. 开始启动 | Get Started
1. 下载[ruov发行版](https://gitee.com/wangjusanmu/ruov),配置环境变量.
2. 若是新项目,执行 `ruov init`,按照提示信息输入配置,会在当前目录下创建项目.
```shell
> ruov init
______ __ __ ______ __ __
/\ == \ /\ \/\ \ /\ __ \ /\ \ / /
\ \ __< \ \ \_\ \ \ \ \/\ \ \ \ \'/
\ \_\ \_\ \ \_____\ \ \_____\ \ \__|
\/_/ /_/ \/_____/ \/_____/ \/_/
Welcome to ruov - Your Command Line Tool.
--- v1.0.beat
2024-08-20 23:50:25 [INFO] : 项目初始化中...
? 应用名称: [? for help, tab for suggestions] (ruov)
? 应用名称: ruov
? 数据库主机: (localhost)
? 数据库主机: localhost
? 数据库端口: (3306)
? 数据库端口: 3306
? 数据库用户名: (root)
? 数据库用户名: root
? 数据库密码: ***
? 数据库名: test
? 数据库名: test
2024-08-20 23:50:35 [INFO] : 项目ruov模板下载中...
2024-08-20 23:50:48 [INFO] : 项目ruov模板解压成功!,路径:E:\back\ruov
Directory created: ruov\.ruov
2024-08-20 23:50:50 [INFO] : 项目ruov meta文件生成成功!
Please focus: https://gitee.com/wangjusanmu/ruov
```
3. 待续
# 3. Rouv交流群