初始化项目结构
Mr.Lee 2025-04-25 19:10:23 favorProject
项目起因呢...... 最近在开发中需要测试Api接口, 就想找个公共的Api对付一下完事. 公开的标准Restfull风格的api都需要鉴权. 所以就想自己实现一套. 反正后面也用的到......
结果在创建项目时, 就想要让新项目融入熟悉的环境体系中 .蛋疼的事来了, 标准的目录结构建起来好费劲....然后就有下面的内容...
# 目录结构
.
├── LICENSE # 开源许可证
├── README.md # 说明文件
├── assets # 项目产生/所需的物料
├── ci-cd # 持续部署(kubernetes)
│ ├── VERSION # 项目版本号
│ ├── build.sh # 构建脚本
│ ├── changelog # 数据库的变更记录(Liquibase)
│ ├── configs # 项目所需配置
│ ├── docker # 构建镜像
│ ├── helm # Chart脚本
│ ├── init # 初始化所需内容
│ └── package # 打包后存放路径
├── docs # 项目文档
│ ├── devel # 开发文档
│ ├── guide # 使用手册
│ └── images # 文档中使用到的图片
├── internal # 项目后台
├── test # 测试脚本
├── vendor # 涉及到第三方
└── website # 项目前台
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# Shell 脚本
#!/bin/bash
# 创建目录结构
mkdir -p \
assets \
ci-cd/{configs,docker,helm,init,package} \
docs/{devel,guide,images} \
internal \
test \
vendor \
website
echo "1.0.0" >> ci-cd/VERSION
echo "#!/bin/bash" >> ci-cd/build.sh
# 给所有空目录添加 .gitkeep 文件
find . -type d -not -path "./.git/*" -empty | while read dir; do
touch "$dir/.gitkeep"
done
echo "init done..."
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
这个
.gitkeep占位文件, 可又是一把辛酸泪...
# 注册命令
# 成果展示
这就建好了, 舒坦~