Express

v4.x

JavaScript / TypeScript

官方网站 GitHub

Express 是一个简洁灵活的 Node.js Web 应用框架，非常轻量且易于上手。

📋 前置要求

Node.js 18+ 已安装

pnpm 已安装

已下载生成的项目代码

📁 项目结构

express

src

index.ts // 入口文件

routes // 路由定义

index.ts

users.ts

controllers // 控制器

middlewares // 中间件

services // 业务逻辑

config // 配置文件

🚀 运行步骤

第 1 步：进入项目目录

bash

        $
        cd backend
      

第 2 步：安装依赖

bash

        $
        pnpm install
      

首次运行

首次运行需要安装依赖，这可能需要几分钟时间。

第 3 步：配置环境变量

复制环境变量示例文件：

bash

        $
        cp .env.example .env
      

然后编辑 .env 文件，配置必要的环境变量：

变量名	说明	必填
PORT 默认值: 3000	服务端口	否
NODE_ENV 默认值: development	运行环境	否
DATABASE_URL	数据库连接字符串	是
JWT_SECRET 默认值: your-secret-key	JWT 密钥	是

第 4 步：数据库迁移（如果有）

如果项目使用了 Prisma：

bash

        $
        pnpm prisma migrate dev
      

如果使用 TypeORM：

bash

        $
        pnpm typeorm migration:run
      

第 5 步：启动开发服务器

bash

        $
        pnpm run dev
      

第 6 步：验证运行

服务启动后，访问以下地址验证：

• API 根路径：http://localhost:3000
• 健康检查：http://localhost:3000/health

启动成功

如果看到 `Server is running on port 3000` 类似的消息，说明服务启动成功！

🔧 常用命令

命令	说明
pnpm run dev	开发模式启动（热重载）
pnpm run build	编译 TypeScript
pnpm run start	生产模式启动
pnpm run lint	代码检查

❓ 常见问题

端口被占用

修改 .env 文件中的 PORT 值，或使用以下命令查找占用进程：

bash

        $
        lsof -i :3000
      

数据库连接失败

1. 确认数据库服务已启动
2. 检查 DATABASE_URL 格式是否正确
3. 确认数据库用户名密码正确

TypeScript 编译错误

bash

        $
        pnpm run build
      

查看错误信息并修复类型问题。

⏭️ 下一步

• 运行前端项目
• 同时运行前后端