# 柿子文档

**Repository Path**: Wshape1/shiziapi

## Basic Information

- **Project Name**: 柿子文档
- **Description**: 柿子文档---在线文档管理平台
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2023-08-21
- **Last Updated**: 2025-04-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Java, SpringBoot, SpringCloud

## README

# 柿子文档

#### 介绍

一个面向公众的文档管理平台，以项目的形式管理文档，可以在线进行文档的编辑等操作，可以添加富文本、Markdown、API等格式的文档，可以邀请好友加入项目，可以对项目进行公开，也可以发现搜索其它公开项目。

#### 技术栈

|         技术          |       版本       |
|:-------------------:|:--------------:|
| SpringCloud Alibaba | 2022.0.0.0-RC2 |
|     SpringBoot      |     3.0.2      |
|     MyBatisPlus     |    3.5.3.1     |
|        Nacos        |     2.2.1      |
|        MySQL        |     8.0.31     |
|      Redisson       |     3.22.0     |
|      RabbitMQ       |     3.9.11     |
|    ElasticSearch    |     7.17.5     |
|       XXL-JOB       |     2.4.0      |
|        Vue3         |     3.2.47     |

#### 目录结构
```
shiziapi-common     -- 通用工具类
shiziapi-gateway    -- 网关服务
shiziapi-uaa        -- 认证授权服务
shiziapi-message    -- 消息服务
shiziapi-project    -- 项目服务
shiziapi-search     -- 搜索服务
shiziapi-mock       -- Mock服务
shiziapi-thirdparty -- 三方服务
shiziapi-frontend   -- 前端项目
```

#### 快速开始
##### Docker启动
构建镜像：
```shell
docker build -t {image_name} .
```
运行容器：
```shell
docker run -d \
-p {本地端口}:8080 \
-e NACOS_SERVER_ADDR={nacos_server_addr} \
-e NACOS_NAMESPACE=public \
-e NACOS_GROUP=DEFAULT_GROUP \
-e JAVA_OPTS="-Xmx256m -Xms64m" \
-name {container_name} \
{image_name}
```