# ruoyi-web

**Repository Path**: Su-Riven/ruoyi-web

## Basic Information

- **Project Name**: ruoyi-web
- **Description**: 一个基于 Vue 3 的现代化 AI 聊天应用前端，支持 ChatGPT、Midjourney 等多种 AI 功能。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://web.pandarobot.chat
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 518
- **Created**: 2025-10-10
- **Last Updated**: 2025-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RuoYi-Web

English | [简体中文](./README.md)

A modern AI chat application frontend based on Vue 3, supporting ChatGPT, Midjourney and other AI features.

## ✨ Features

- 🤖 **ChatGPT Conversations** - Multi-turn dialogues with intelligent responses
- 🎨 **Midjourney Drawing** - AI image generation and editing
- 🎵 **Voice Features** - Speech recognition and text-to-speech
- 📱 **Responsive Design** - Desktop and mobile support
- 🌍 **Internationalization** - Multi-language support
- 🎨 **Theme Switching** - Light and dark theme toggle

## 🛠️ Tech Stack

- **Framework**: Vue 3 + TypeScript
- **Build Tool**: Vite
- **UI Components**: Naive UI + Element Plus
- **State Management**: Pinia
- **Routing**: Vue Router
- **Styling**: TailwindCSS + Less
- **Icons**: Iconify
- **PWA**: Vite PWA Plugin

## 📋 Requirements

- **Node.js**: >= 16.0.0
- **npm**: >= 8.0.0 (or use pnpm/yarn)

## 🚀 Quick Start

### Download Project

```bash
git clone https://github.com/ageerle/ruoyi-web
cd ruoyi-web
```

### Install Dependencies

```bash
npm install
```

### Run Project

```bash
npm run dev
```

The project will start at `http://localhost:1002`

### Build for Production

```bash
npm run build
```

## 📦 Available Scripts

```bash
# Start development server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

# Type checking
npm run type-check

# Lint code
npm run lint

# Auto-fix code formatting
npm run lint:fix

# Documentation development
npm run docs:dev

# Build documentation
npm run docs:build
```

## 🔧 Configuration

The project uses environment variables for configuration. Create a `.env` file as needed:

```env
# API base URL
VITE_APP_API_BASE_URL=your_api_url

# Enable PWA
VITE_GLOB_APP_PWA=true
```

## 📁 Project Structure

```
ruoyi-web/
├── public/                 # Static assets
├── src/
│   ├── api/               # API interfaces
│   ├── assets/            # Asset files
│   ├── components/        # Common components
│   ├── hooks/             # Composition functions
│   ├── locales/           # Internationalization
│   ├── router/            # Router configuration
│   ├── store/             # State management
│   ├── styles/            # Style files
│   ├── utils/             # Utility functions
│   ├── views/             # Page components
│   └── main.ts            # Entry file
├── docs/                  # Documentation and screenshots
└── package.json
```

## 🤝 Contributing

Issues and Pull Requests are welcome to improve the project.

## 📄 License

This project is open source under the MIT License.

## 👨‍💻 Author

- **ageer** - [ageerle@163.com](mailto:ageerle@163.com)

---

⭐ If this project helps you, please give it a star!