# faka

**Repository Path**: private-item/faka

## Basic Information

- **Project Name**: faka
- **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-08-13
- **Last Updated**: 2025-08-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 自动发卡系统

一个基于 Vue3 + Node.js + PostgreSQL 的闲鱼淘宝自动发卡后台管理系统。

## 功能特性

- 🚀 现代化技术栈：Vue3 + TypeScript + Element Plus
- 🔐 完善的身份认证和权限管理
- 📦 商品和卡密管理
- 🤖 自动发卡功能
- 📊 数据统计和分析
- 🔌 平台API集成（淘宝、闲鱼）
- 📱 响应式设计，支持移动端

## 技术栈

### 后端
- **运行环境**: Node.js 18+
- **框架**: Express.js + TypeScript
- **数据库**: PostgreSQL + Redis
- **身份认证**: JWT
- **API文档**: 待添加

### 前端
- **框架**: Vue 3 + TypeScript
- **UI库**: Element Plus
- **状态管理**: Pinia
- **路由**: Vue Router
- **构建工具**: Vite
- **HTTP客户端**: Axios

## 快速开始

### 环境要求

- Node.js >= 18.0.0
- PostgreSQL >= 12.0
- Redis >= 6.0
- pnpm >= 8.0.0

### 安装依赖

```bash
# 安装后端依赖
cd backend
pnpm install

# 安装前端依赖
cd ../frontend
pnpm install
```

### 数据库设置

1. 创建 PostgreSQL 数据库：
```sql
CREATE DATABASE faka_system;
```

2. 运行数据库初始化脚本：
```bash
psql -d faka_system -f backend/src/config/database.sql
```

### 环境配置

1. 复制环境变量文件：
```bash
# 后端
cp backend/.env.example backend/.env

# 前端
cp frontend/.env.example frontend/.env
```

2. 根据实际情况修改环境变量配置

### 运行项目

```bash
# 启动后端开发服务器
cd backend
pnpm dev

# 启动前端开发服务器
cd frontend
pnpm dev
```

访问地址：
- 前端：http://localhost:5173
- 后端API：http://localhost:3000

### 默认登录

系统启动后，需要手动创建管理员账户：

```bash
# 使用API创建管理员
curl -X POST http://localhost:3000/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "username": "admin",
    "email": "admin@example.com",
    "password": "123456",
    "role": "super_admin"
  }'
```

## 项目结构

```
faka/
├── backend/                 # 后端代码
│   ├── src/
│   │   ├── config/         # 配置文件
│   │   ├── controllers/    # 控制器
│   │   ├── middleware/     # 中间件
│   │   ├── models/         # 数据模型
│   │   ├── routes/         # 路由
│   │   ├── services/       # 业务逻辑
│   │   ├── types/          # 类型定义
│   │   └── utils/          # 工具函数
│   └── package.json
├── frontend/               # 前端代码
│   ├── src/
│   │   ├── api/           # API接口
│   │   ├── components/    # 通用组件
│   │   ├── router/        # 路由配置
│   │   ├── stores/        # 状态管理
│   │   ├── types/         # 类型定义
│   │   ├── utils/         # 工具函数
│   │   └── views/         # 页面组件
│   └── package.json
├── docs/                  # 文档
├── CLAUDE.md             # 代码规范
├── TODO.md               # 开发计划
└── README.md
```

## 开发指南

### 代码规范

请严格遵循 [CLAUDE.md](./CLAUDE.md) 中定义的代码规范。

### 提交规范

使用传统的提交信息格式：
- `feat:` 新功能
- `fix:` 修复问题
- `docs:` 文档更新
- `style:` 代码格式调整
- `refactor:` 代码重构
- `test:` 测试相关
- `chore:` 构建过程或辅助工具的变动

### 开发计划

查看 [TODO.md](./TODO.md) 了解详细的开发计划和进度。

## API 文档

### 认证接口

- `POST /api/auth/login` - 用户登录
- `POST /api/auth/register` - 用户注册
- `GET /api/auth/profile` - 获取用户信息
- `PUT /api/auth/change-password` - 修改密码

更多API文档待补充...

## 部署

### 生产环境构建

```bash
# 构建前端
cd frontend
pnpm build

# 构建后端
cd ../backend
pnpm build
```

### Docker 部署

待添加 Docker 配置...

## 许可证

MIT License

## 贡献

欢迎提交 Issue 和 Pull Request！

## 联系方式

如有问题，请提交 Issue 或联系开发者。