# @bts-soft/create-starter 中文文档

规范地址：https://npmcn.com/package/%40bts-soft/create-starter/

版本：1\.7\.2
npm 元数据更新时间：2026-11-04T23:09:00.047Z
中文译文更新时间：2026-11-08T20:26:15.466Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bts-soft/create-starter
原文对照：https://npmcn.com/package/%40bts-soft/create-starter/?lang=original
项目主页：https://github.com/Omar-Sa6ry/nest-starter#readme
源码仓库：https://github.com/Omar-Sa6ry/nest-starter

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：12 kB，3 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.0\.0
- 运行依赖：1 个
- 首次发布：2026-10-25T13:53:49.933Z
- 最新版本发布：2026-11-04T23:08:59.885Z
- 近 30 天下载量：2596（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

制作准备的 NestJS 12 启动器 CLI 模板生成器: 规定 GraphQL (Apollo code- first), TypeORM + PostgreSQL, Redis, JWT auth 有刷新旋转, RBAC, OAuth2, 速率限制, S3/ MNIO 媒体上传, BullMQ 工人, WebSocket 网关, 和 mul

## 安装

```sh
npm install @bts-soft/create-starter
```

也可以使用：`pnpm add @bts-soft/create-starter`、`yarn add @bts-soft/create-starter`、`bun add @bts-soft/create-starter`

## README

# @bts-soft/创建-启动器

用于生产准备的NestJS 12 企业启动器模板的 CLI 模板生成器(`Omar-Sa6ry/nest-starter`) (中文(简体) ).

* * *

## 概览

`@bts-soft/create-starter` 为克隆,再品牌,并初始化生产级的NestJS后端提供零配置命令行接口. 将重复设置的活儿自动化:

-   克隆从 GitHub 直接取自官方启动存储器 `degit`。 。 。 .
-   自动剥去内部脚手架目录( E)`create-starter/` 财务报告和审定财务报表 `media-frontend/`) (中文(简体) ).
-   执行递归多文件字符串替换自定义工程名称,软件包名称,数据库名称,以及服务标识符.
-   执行依赖性安装( E)`make install`自动.
-   为推出多克开发服务并启动应用程序提供可立即采取行动的下一步措施.

* * *

## 先决条件

确保您的主机系统满足以下要求:

-   **节点.js**数字 : `>= 22.0.0`
-   **无**数字 : `>= 10.0.0`
-   **生产**: GNU (韩语) 制作( 如果手工引用 npm/ docker 命令, 可选择)
-   **嵌入器( D)**: 运行数据库、缓存和对象存储堆栈所需的

* * *

## 快速启动

### 1\. 创建一个新项目

使用生成器执行 `npm create`数字 :

```bash
npm create @bts-soft/starter my-service
```

或者,如果运行命令时没有参数,交互式提示会请求目标工程名称:

```bash
npm create @bts-soft/starter
```

### 2\. 自动发生的事情

在初始化期间, `@bts-soft/create-starter` 执行下列顺序:

1.  下载仓库快照 `Omar-Sa6ry/nest-starter#main` (或 `#master`) (中文(简体) ).
2.  清理开发脚手架目录 :
    -   删除 `create-starter/`
    -   删除 `media-frontend/`
3.  自定义服务配置 :
    -   重命名软件包名称 `package.json` 转到您的工程名称.
    -   调整 TypeORM 数据库名称( 例如 ). `my_service_db`, (中文(简体) ), `my_service_test_db`, (中文(简体) ), `my_service_staging`) (中文(简体) ).
    -   更新提醒管理器、 Prometheus 任务名称以及 Docker 容器标识符 .
4.  自动更新依赖关系( E)`npm run update`通过执行来安装依赖关系 `make install`。 。 。 .

### 3\. 今后的步骤

导航您新生成的工程文件夹 :

```bash
cd my-service
```

启动本地支持服务( PostgreSQL, Redis, MinIO S3, Prometheus):

```bash
make docker-dev-up
```

在开发监视模式中启动应用程序 :

```bash
make dev
```

* * *

## 项目结构目标

生成的项目预配置为:

-   **雀巢号12**: 在本土ECMAScript模块(ESM)下快活/快活.
-   **图QL**: 代号- 第一代计划与阿波罗服务器.
-   **关系存储**: TypeORM + PostgreSQL 有迁移,软删除等功能,并有种子.
-   **记忆缓存状态( N)**: Redis 缓存管理器, 令牌黑名单, 并分发会话存储 .
-   **安保和中非区域局**: JWT 访问/再更新令牌旋转,Google OAuth 2.0,Helmet,CORS,以及许可装饰.
-   **媒体文件处理( F)**: S3/MINIO相容的上传会话,多段上传,和BullMQ工人队列处理.
-   **实时网关**: 苏克特. 具有Redis适配器支持的IO网关用于水平集群.
-   **多频道通知**: Email (Nodemailer),SMS (Twilio),和Push通知 (Firebase Admin).
-   **支付引擎**: 统一网关,用于Frede,PayPal,Paymob,和Fawry Pay,并带有自动的webhook验证.
-   **观察性**: 普罗米修斯度量衡(`/metrics`),健康探测器(`/health`, (中文(简体) ), `/health/ready`温斯顿/皮诺伐木系统具有微量相关性.
-   **堆栈**:为发展、试验、中转和生产创造专门的环境.

* * *

## 出版和维护

要发布此 CLI 工具的新版本 :

1.  更新版本编号 `package.json`数字 :
    
    ```bash
    npm version patch
    ```
    
2.  将更改提交到 GitHub .
3.  认证软件包并将其发布到 npm 公共注册 :
    
    ```bash
    npm publish --access public
    ```
    

* * *

## 许可证

此软件包根据 [Apache-2.0 许可证](https://opensource.org/licenses/Apache-2.0)。 。 。 .

## 常见问题

### @bts-soft/create-starter 是什么？

制作准备的 NestJS 12 启动器 CLI 模板生成器: 规定 GraphQL \(Apollo code- first\), TypeORM \+ PostgreSQL, Redis, JWT auth 有刷新旋转, RBAC, OAuth2, 速率限制, S3/ MNIO 媒体上传, BullMQ 工人, WebSocket 网关, 和 mul

### 如何安装 @bts-soft/create-starter？

在项目目录运行 npm install @bts-soft/create-starter，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 create-starter，可以用 npx create-starter 直接运行。

### @bts-soft/create-starter 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/bts-soft\_\_create-starter 是否存在。

### @bts-soft/create-starter 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @bts-soft/create-starter 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @bts-soft/create-starter 可以商用吗？

@bts-soft/create-starter 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @bts-soft/create-starter 的下载量有多少？

根据 npm 官方下载统计，@bts-soft/create-starter 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,596 次，日均约 87 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bts-soft/create-starter 还在维护吗？

最新版本 1\.7\.2 发布于 2026/11/05（3 天前）；至今共发布 15 个版本，其中过去 12 个月发布了 15 个；首次发布于 2026/10/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。