NServe

Appearance

NServe ​

NServe 是一个 Node.js 服务器端开发 CLI 工具，旨在简化 Node.js 服务器应用的开发、构建和部署流程。它提供了代码生成、热重载开发服务器和项目构建等功能，帮助开发者快速搭建和维护 Node.js 服务器应用。

快速开始 ​

您可以使用以下命令创建一个新的 NServe 项目：

使用 NPM: ​

sh
$ npm create nserve@latest

使用 Yarn: ​

sh
$ yarn create nserve@latest

使用 PNPM: ​

sh
$ pnpm create nserve@latest

核心功能 ​

  • 代码生成：根据配置文件自动生成 Express 路由和数据模型
  • 开发服务器：支持 TypeScript 实时编译和热重载
  • 项目构建：使用 esbuild 进行快速构建和优化

核心功能 ​

NServe 提供了三个主要命令：

  • nserve serve - 启动开发服务器
  • nserve build - 构建项目
  • nserve gen - 根据配置文件生成代码

快速上手 ​

  1. 创建项目结构
  2. 配置 nserve.config.ts
  3. 编写路由配置文件
  4. 编写 SQL 模型文件
  5. 运行 nserve gen 生成代码框架
  6. 实现业务逻辑
  7. 使用 nserve serve 启动开发服务器进行测试
  8. 使用 nserve build 构建生产版本

项目结构 ​

project/
├── src/                      # 源代码目录
│   ├── handler/             # 路由处理器
│   ├── logic/               # 业务逻辑
│   ├── model/               # 数据模型
│   └── app.ts               # 应用入口
├── nserve-config/           # 生成配置目录
│   ├── router/              # 路由配置
│   └── model/               # 模型 SQL 文件
├── nserve.config.ts         # NServe 配置文件
└── package.json             # 项目配置
└── tsconfig.json             # TypeScript 配置文件