# screw-extent

**Repository Path**: swotxu/screw-extent

## Basic Information

- **Project Name**: screw-extent
- **Description**: https://gitee.com/leshalv/screw.git 快速生成DB文档的扩展
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-07-12
- **Last Updated**: 2022-08-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Screw-Web

#### 介绍
本工程为 Data Dictionary Automation 项目，主要是帮助用户，针对其自有的数据库，提供实时可视化的在线表结构文档。由Java语言开发，基于Spring-Boot快速搭建的脚手架项目，主要引用了Screw插件。
> *Screw* - 简洁好用的数据库表结构文档生成工具 
>
> 项目地址：`https://gitee.com/leshalv/screw.git`

#### 数据库支持
- MySQL
- MariaDB
- TIDB
- Oracle
- SqlServer
- PostgreSQL
- Cache DB（2016）

#### 软件架构
`screw` <br/>
&nbsp;&nbsp;`|-- screw-simple`    *简单快速入门 demo <br/>*
&nbsp;&nbsp;`|-- screw-web`       *web模块 <br/>*

#### 安装教程
1. 进入 `screw-web`项目路径下
    ```shell script
    cd screw-web
    ```
2. 快速构建 jar/zip 包
    ```shell script
    mvn clean install -Dmaven.test.skip=true
    ```
3. 单独构建 zip 包
    ```shell script
    mvn -Dmaven.test.skip=true  assembly:single
    ```
4. 将 `zip` 包解压到指定目录即可快速使用


#### 目录简介

`screw` <br/>
&nbsp;&nbsp;`|-- bin`    *启动脚本 <br/>*
&nbsp;&nbsp;`|-- conf`   *配置文件 <br/>*
&nbsp;&nbsp;`|-- doc`    *项目生成的文档目录 <br/>*
&nbsp;&nbsp;`|-- lib`    *项目依赖 <br/>*
&nbsp;&nbsp;`|-- rest`   *项目提供的API简介 <br/>*
&nbsp;&nbsp;`|-- README.md`       *使用说明 <br/>*
&nbsp;&nbsp;`|-- screw.jar`       *构建的`screw-web.jar`*


#### 使用说明

1. 修改配置 `conf/screw-db.xml`

2. 启动服务

    Windows 运行 `bin/run.bat`，Linux 运行 `bin/run.sh start`

3. 访问使用 `http://127.0.0.1:8080/login` 
    
    默认用户 `admin` ，默认密码 `123`

注：查看服务完整API调用，见 `rest/*.http`

#### Docker 集成
本项目默认使用打为可发布包zip使用，若需使用推送docker镜像的方法发布本项目，可进行如下操作。

1. 修改`pom.xml`文件。
    
    注释`maven-jar-plugin`和`maven-assembly-plugin`打包插件，
    采用`spring-boot-maven-plugin`和`docker-maven-plugin`打包插件
   
2. 构建 jar 包和 docker image
    ```shell script
    cd screw-web
    # 构建 jar包
    mvn clean install -Dmaven.test.skip=true
    # 单独创建镜像
    mvn docker:build
    ```
 
3. 启动容器。可以在idea中配置docker插件来启动，或者直接命令行启动
    ```shell script
    docker run -di -p 8080:8080 --name=screw-service \
    -v /data/docker-data/xuhai/screw/conf:/screw/conf \
    -v /data/docker-data/xuhai/screw/logs:/screw/logs \
    -v /data/docker-data/xuhai/screw/doc:/screw/doc \
    -d xuhai-screw
    ```