# kudcms

**Repository Path**: devoink/kudcms

## Basic Information

- **Project Name**: kudcms
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-12
- **Last Updated**: 2025-12-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DECMS - 内容管理系统

基于 NestJS + Vue3 的现代化 CMS 系统。

## 技术栈

### 后端

- NestJS + TypeScript
- PostgreSQL + TypeORM
- JWT + Refresh Token + Cookie
- Winston 日志
- Swagger API 文档

### 前端（待开发）

- Vue3 + TypeScript
- Vite
- shadcn-vue
- Tailwind CSS
- Pinia

## 快速开始

### 前置要求

- Node.js >= 18
- Yarn
- Docker & Docker Compose（用于数据库）

### 1. 克隆项目

```bash
git clone git@gitee.com:devoink/kudcms.git
cd decms
```

### 2. 启动数据库

```bash
# 使用 Docker Compose 启动 PostgreSQL
docker compose up -d

# 查看数据库状态
docker compose ps
```

### 3. 配置后端

```bash
cd backend

# 安装依赖
yarn install

# 复制环境变量文件
cp .env.example .env

# 编辑 .env 文件（如果需要修改数据库配置）
# 默认配置已适配 Docker Compose
```

### 4. 启动后端服务

```bash
cd backend

# 开发模式
yarn start:dev

# 生产模式
yarn build
yarn start:prod
```

### 5. 访问服务

- 后端 API: http://localhost:3000
- Swagger 文档: http://localhost:3000/api（待配置）
- pgAdmin: http://localhost:5050（可选）

## 开发指南

### 数据库管理

详细说明请查看 [开发环境配置文档](docs/开发环境配置.md)

**快速命令：**

```bash
# 启动数据库
docker compose up -d

# 停止数据库
docker compose down

# 查看数据库日志
docker compose logs -f postgres

# 进入数据库命令行
docker exec -it decms-postgres psql -U postgres -d decms
```

### 代码规范

- 使用 ESLint 和 Prettier 进行代码格式化
- 遵循 Conventional Commits 提交规范
- 一次只开发一个文件或小功能

### 开发流程

1. 先设计表结构
2. 搭建开发环境和工程化
3. 开发业务代码（一次一个文件/功能）
4. 测试和文档更新

详细开发方案请查看 [开发方案文档](docs/开发方案.md)

## 项目结构

```
decms/
├── backend/          # NestJS 后端项目
├── admin/            # Vue3 管理后台（待开发）
├── docs/             # 项目文档
└── docker-compose.yml # Docker 配置
```

## 相关文档

- [开发方案](docs/开发方案.md)
- [数据库设计](docs/数据库设计.md)
- [用户认证表设计说明](docs/用户认证表设计说明.md)
- [开发环境配置](docs/开发环境配置.md)

## 许可证

UNLICENSED