logo
0
0
WeChat Login
cnb<noreply@cnb.cool>
docs: 补全 README — 使用方式、目录约定、适用场景

CNBMM 项目脚手架

客户部(cnbmm)标准项目初始化模板,开箱即用的目录结构与基础配置。

目录结构

├── src/        # 源代码
│   └── index.js
├── tests/      # 单元测试
│   └── index.test.js
├── docs/       # 项目文档
│   └── guide.md
└── README.md   # 项目说明

使用方式

方式一:在 CNB 平台使用模板

  1. 打开 cnbmm/scaffold
  2. 点击 「使用模板」 创建新仓库
  3. 根据项目类型修改 src/ 下的代码入口

方式二:本地克隆

git clone https://cnb.cool/cnbmm/scaffold.git my-project
cd my-project
rm -rf .git
git init

目录约定

目录用途说明
src/源代码业务逻辑、入口文件
tests/测试单元测试、集成测试
docs/文档API 文档、设计文档、使用指南

适用项目类型

  • 微信小程序(配合 CloudBase)
  • H5 移动端应用(Vue3 / TDesign Mobile)
  • Node.js 后端服务
  • 云函数项目

组织归属

许可

MIT

About

客户部 · 仓库初始化模板

template