初始化项目

现在假定你的项目名称为 myorm，以下出现 myorm 名称的时候指的都是你的项目名称，在实际工作中请替换成你自己项目的名称。

安装依赖包

创建项目目录 myorm 并使用 vscode 打开项目文件夹

打开 vscode 的 终端 并输入命令初始化一个 npm 项目：

npm

npm init

Yarn

yarn init

pnpm

pnpm init

根据命令行提示完善你的 npm 项目信息。

添加 zenorm 依赖

npm

npm install zenorm

Yarn

yarn add zenorm

pnpm

pnpm add zenorm

添加开发依赖

npm

npm install --save-dev dotenv typescript rimraf @zenorm/generate @zenorm/generate-mysql

Yarn

yarn add --dev dotenv typescript rimraf @zenorm/generate @zenorm/generate-mysql

pnpm

pnpm add --save-dev dotenv typescript rimraf @zenorm/generate @zenorm/generate-mysql

添加 npm 指令

在 package.json 文件的 scripts 块中添加以下指令：

package.json

"scripts": {
  "dev": "ts-node -r dotenv/config",
  "dbgen": "zenorm-generate .dbgen.json",
  "build": "rimraf dist && tsc"
}

创建 TypeScript 配置文件

在项目目录中新建文件 tsconfig.json

tsconfig.json

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    "target": "ES2019",
    "lib": [ "ES2019" ],
    "module": "commonjs",
    "strict": true,
    "sourceMap": true,
    "outDir": "./dist"
  },
  "exclude": [ "node_modules" ],
  "include": [ "src/**/*" ]
}

备注

正确配置 tsconfig 文件很关键，因为 zenorm 高度依赖 TypeScript 的 Decorators 特性

配置开发时环境变量

开发时需要指定一些环境变量给项目使用，我们使用 dotenv 工具来解决这个问题。

在项目根目录创建 .env 文件

.env

NODE_ENV=development
DEBUG=*

变量说明：

变量	说明
NODE_ENV	指定当前使用环境，开发环境为 development，生产环境为 production
DEBUG	指定 debug 函数需要输出的内容， 关于 debug 函数的使用请参考 debug 函数的一些常见用法

关于生产环境变量

在生产环境中我们会使用 Dockerfile 来指定环境变量，不再需要 dotenv 包，这里的 .env 文件只会用于本地开发