# 公共

**Repository Path**: MacXiang/public

## Basic Information

- **Project Name**: 公共
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-12
- **Last Updated**: 2025-09-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 公共

### 介绍
{**以下是 Gitee 平台说明，您可以替换此简介**
Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台
无论是个人、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)}

### 软件架构
    旨在规范一个通用的文件目录结构

### 安装教程

    1.  如果使用 git clone https://gitee.com/tmkmk/public.git 后,必须再使用 git submodule update --init --recursive
        或者直接 git clone --recurse-submodules https://gitee.com/tmkmk/public.git 自动下载关联项目
    2.  本目录下、module、method 这三个目录下都需要安装npm依赖; 运行 npm i;
    3.  Utils是java后台用到相关的,如果不用可以不管;

### 使用说明

    1.  module是前端方便用作数据拉取时格式化,以及简单的常用的一些方法封装
        父项目需要在此目录下
            由于每个项目所需要定义的数据类型等文件较多,特做了一个简单的示例,example,将里面内容复制至项目目录同级下即可 
    2.  script 则是一些常用工具,以node环境运行; 例如: npm re命令则是重新打包api后端;具体进入代码查看;后续可能会对每个命令进行说明
    3.  Utils则是封装后端所用


#### 关于git方面的备忘
    链接第三方仓库命令 git submodule add -f https://gitee.com/tmkmk/public.git public
    链接完后,需要运行命令,以加载三方库所引入的其他仓库
          git submodule update --init --recursive
    如果本地已经有了public,可以使用cmd命令,此命令是将本地的一个目录硬链接到当前目录,节省硬盘开销;
          mklink /d /h /j public d:\code\public


#### 最终的总项目目录结构应该是这样的
    项目根目录
    ├── api                    # Java后端相关代码
    ├── admin                  # UniApp后台控制系统相关代码
    ├── app                    # UniApp移动端相关代码
    ├── public                 # 本项目代码
    │   ├── README.md          # 项目说明文档
    │   ├── example            # 示例目录
    │   │   ├── README.md      # 示例目录，内容的说明
    │   │   └── dataBase       # 要复制到项目根目录下,欲public目录同级的示例内容;之所以这么搞,是因为学识受限,不知道怎么解决差异化git版本控制
    │   ├── method             # 引入三方库,里面封装了一些常用方法;
    │   ├── module             # 导出的公共模块相关; 在前端项目中需要用到的所有东西都从这里引入;
    │   ├── script             # 常用工具脚本，Node环境运行
    │   └── Utils              # 后端封装相关代码（Java后台用到）
    └── dataBase               # 从公共文件项目里复制出来的特异性代码
##### 正式使用流程(使用说明下的123)
    1.  创建项目目录,并初始化git
    2.  创建目录 admin、api、app
    3.  git submodule add -f https://gitee.com/MacXiang/public.git public
    4.  cd public;pnpm i;
    5.  git submodule update --init --recursive;
    6.  cd module; pnpm i;
    7.  cd ../method; pnpmi;
        完成后回到项目根目录
    8.  如果本地已经有了public,并想统一管理,且不想浪费硬盘;可以忽略步骤4-7,在执行完3后,将public目录删除,执行 mklink /d /h /j public d:\code\public
        其中d:\code\public 为你public项目的路径
    9.  复制public/example/dataBase到 当前项目下;例如: copy public/example/dataBase dataBase


### 参与贡献

    1.  Fork 本仓库
    2.  新建 Feat_xxx 分支
    3.  提交代码
    4.  新建 Pull Request


### 特技

    1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
    2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
    3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
    4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
    5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
    6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)