Skip to content

安装

环境准备

  • 操作系统:支持 macOS,Windows
  • 运行环境:node >= 18.16.0

快速构建项目

推荐使用脚手架快速初始化项目。

通过下方的命令全局安装脚手架

npm install think-ts-cli -g
npm install think-ts-cli -g

然后通过 think-ts-cli init <项目名称> 命令初始化项目

think-ts-cli init project-name
think-ts-cli init project-name
thinkts

输入 Y 之后通过上下键选择框架类型

基础框架是纯净版,不含用于演示功能的业务逻辑,根据情况选择对应的框架


接着在项目目录下通过 npm install 将项目所需要的依赖安装上, npm run dev 开发环境查看


开发环境

开发环境下启动项目:

npm run dev
npm run dev

生产环境

生产环境下是基于pm2启动的:

npm run start
npm run start

多环境

多环境启动项目需要自行修改 package.jsonconfig/pm2.json 文件,配置不同的环境变量

// package.json
"scripts": {
    ...
    "start:test": "pm2 start config/pm2.json --env test"
}

// config/pm2.json
// 基于PM2启动的配置文件
{
    "apps": [
        {
            "name": "think-ts",
            "script": "index.ts",
            "interpreter": "ts-node",
            "watch": false,
            "exec_mode": "cluster",
            "instances": 2,
            "env_production": {
                "NODE_ENV": "production"
            },
            "env_test": {
                "NODE_ENV": "test"
            }
        }
    ]
}

npm run start:test
// package.json
"scripts": {
    ...
    "start:test": "pm2 start config/pm2.json --env test"
}

// config/pm2.json
// 基于PM2启动的配置文件
{
    "apps": [
        {
            "name": "think-ts",
            "script": "index.ts",
            "interpreter": "ts-node",
            "watch": false,
            "exec_mode": "cluster",
            "instances": 2,
            "env_production": {
                "NODE_ENV": "production"
            },
            "env_test": {
                "NODE_ENV": "test"
            }
        }
    ]
}

npm run start:test

注意:程序默认运行在 5985 端口下,如果项目启动时提示端口占用,请通过 config/app.ts 配置文件修改端口,或者杀掉占用的进程

备案号:冀ICP备20015584号-2