# node-ts-express

**Repository Path**: coder-farmer/node-ts-express

## Basic Information

- **Project Name**: node-ts-express
- **Description**: node typescript express 的一个后端基架，rollup 打包发布
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2024-09-18
- **Last Updated**: 2026-05-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### node + ts + express + rollup 打包项目

**目的：实现一个以 express 的基本后端基架，包含功能**

当前进度（已完成/待完成）：

1. jwt 中间件 ✅
2. 过滤中间件 ✅
3. 日志 loggers ✅
4. 权限控制 ✅
5. schema - zod 验证 ✅
6. 数据库链接（---）
7. orm 框架（暂不考虑）
8. redis（后续）
9. 多语言（后续）
10. MQ（后续）
11. docker（后续）

规划与需求（保留并明确）：

- 需要增加用户表功能，包含用户注册、登录、权限控制等功能。
- 需要增加 schema 验证功能，使用 zod 进行数据验证（已完成）。
- ORM 框架暂时不考虑，后续增加。
- postgres 数据库接入，用户信息存储，权限控制等功能。
- redis 后面接入，先不做缓存或暂时用 session 做缓存机制。
- 需要接入 next 做双端管理功能。

项目描述：

本项目是一个基于 Node.js + TypeScript + Express 的后端骨架，按模块化结构组织，适合做小型到中型服务的快速迭代。当前已实现认证、权限、日志、接口校验等核心中间件，后续补充数据库、缓存、ORM、国际化、MQ、Docker 部署。

#### 项目运行

1. 安装项目
   ```npm
   npm install
   ```
2. 开发模式运行
   ```npm
   npm run dev
   ```
3. 类型检查
   ```npm
   npm run typecheck
   ```
4. 项目打包
   ```npm
   npm run build
   ```
5. 运行打包后的产物
   ```npm
   npm start
   ```
6. 打包并监听源码自动重启
   ```npm
   npm run build:start
   ```
   > 说明：build:start 会监听 src 目录并重建 dist 后重启服务。

#### 核心路由

- 健康检查：GET /api/v1/health
- 用户模块：/api/v1/user/*
- 商品模块：/api/v1/goods/*

#### 环境变量

- 复制 .env.example 为 .env 后按需修改。