翻译文档
This commit is contained in:
yinjianm
@@ -9,19 +9,19 @@
|
||||
|
||||
</div>
|
||||
|
||||
## 📖 Introduction
|
||||
## 项目简介
|
||||
|
||||
Xboard is a modern panel system built on Laravel 11, focusing on providing a clean and efficient user experience.
|
||||
Xboard 是基于 Laravel 11 构建的现代化面板系统，专注于提供简洁高效的使用体验。
|
||||
|
||||
## ✨ Features
|
||||
## 功能特性
|
||||
|
||||
- 🚀 Built with Laravel 12 + Octane for significant performance gains
|
||||
- 🎨 Redesigned admin interface (React + Shadcn UI)
|
||||
- 📱 Modern user frontend (Vue3 + TypeScript)
|
||||
- 🐳 Ready-to-use Docker deployment solution
|
||||
- 🎯 Optimized system architecture for better maintainability
|
||||
- 基于 Laravel 12 + Octane，显著提升性能
|
||||
- 全新后台界面（React + Shadcn UI）
|
||||
- 现代化用户前端（Vue3 + TypeScript）
|
||||
- 开箱即用的 Docker 部署方案
|
||||
- 优化系统架构，提升可维护性
|
||||
|
||||
## 🚀 Quick Start
|
||||
## 快速开始
|
||||
|
||||
```bash
|
||||
git clone -b compose --depth 1 https://github.com/Micah123321/Xboard && \
|
||||
@@ -34,70 +34,70 @@ docker compose run -it --rm \
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
> After installation, visit: http://SERVER_IP:7001
|
||||
> ⚠️ Make sure to save the admin credentials shown during installation
|
||||
> 安装完成后访问： http://SERVER_IP:7001
|
||||
> 请务必保存安装过程中显示的管理员凭据
|
||||
|
||||
## 📖 Documentation
|
||||
## 文档
|
||||
|
||||
### 🔄 Upgrade Notice
|
||||
> 🚨 **Important:** This version involves significant changes. Please strictly follow the upgrade documentation and backup your database before upgrading. Note that upgrading and migration are different processes, do not confuse them.
|
||||
### 升级说明
|
||||
> **重要：** 此版本包含较大变更。升级前请严格遵循升级文档并备份数据库。请注意，“升级”与“迁移”是不同流程，不要混淆。
|
||||
|
||||
### Development Guides
|
||||
- [Plugin Development Guide](./docs/en/development/plugin-development-guide.md) - Complete guide for developing XBoard plugins
|
||||
- [Developer Guide (ZH-CN)](./docs/development-guide.zh-CN.md) - Local development, testing, running and build guide
|
||||
- [V2bX Integration Guide (ZH-CN)](./docs/v2bx-integration.zh-CN.md) - Full Xboard ↔ V2bX integration guide
|
||||
### 开发指南
|
||||
- [插件开发指南](./docs/en/development/plugin-development-guide.md) - Xboard 插件开发完整说明
|
||||
- [开发者指南（ZH-CN）](./docs/development-guide.zh-CN.md) - 本地开发、测试、运行与构建指南
|
||||
- [V2bX 对接指南（ZH-CN）](./docs/v2bx-integration.zh-CN.md) - Xboard 到 V2bX 的完整对接指南
|
||||
|
||||
### Deployment Guides
|
||||
- [Deploy with 1Panel](./docs/en/installation/1panel.md)
|
||||
- [Deploy with Docker Compose](./docs/en/installation/docker-compose.md)
|
||||
- [Deploy with aaPanel](./docs/en/installation/aapanel.md)
|
||||
- [Deploy with aaPanel + Docker](./docs/en/installation/aapanel-docker.md) (Recommended)
|
||||
### 部署指南
|
||||
- [使用 1Panel 部署](./docs/en/installation/1panel.md)
|
||||
- [使用 Docker Compose 部署](./docs/en/installation/docker-compose.md)
|
||||
- [使用 aaPanel 部署](./docs/en/installation/aapanel.md)
|
||||
- [使用 aaPanel + Docker 部署](./docs/en/installation/aapanel-docker.md)（推荐）
|
||||
|
||||
### Migration Guides
|
||||
- [Migrate from v2board dev](./docs/en/migration/v2board-dev.md)
|
||||
- [Migrate from v2board 1.7.4](./docs/en/migration/v2board-1.7.4.md)
|
||||
- [Migrate from v2board 1.7.3](./docs/en/migration/v2board-1.7.3.md)
|
||||
- [Upgrade from new-dev to latest Docker](./docs/en/migration/new-dev-to-latest-docker.md)
|
||||
### 迁移指南
|
||||
- [从 v2board dev 迁移](./docs/en/migration/v2board-dev.md)
|
||||
- [从 v2board 1.7.4 迁移](./docs/en/migration/v2board-1.7.4.md)
|
||||
- [从 v2board 1.7.3 迁移](./docs/en/migration/v2board-1.7.3.md)
|
||||
- [从 new-dev 升级到最新 Docker 版本](./docs/en/migration/new-dev-to-latest-docker.md)
|
||||
|
||||
## 🛠️ Tech Stack
|
||||
## 技术栈
|
||||
|
||||
- Backend: Laravel 11 + Octane
|
||||
- Admin Panel: React + Shadcn UI + TailwindCSS
|
||||
- User Frontend: Vue3 + TypeScript + NaiveUI
|
||||
- Deployment: Docker + Docker Compose
|
||||
- Caching: Redis + Octane Cache
|
||||
- 后端：Laravel 11 + Octane
|
||||
- 管理后台：React + Shadcn UI + TailwindCSS
|
||||
- 用户前端：Vue3 + TypeScript + NaiveUI
|
||||
- 部署方式：Docker + Docker Compose
|
||||
- 缓存：Redis + Octane Cache
|
||||
|
||||
## 📷 Preview
|
||||
## 预览
|
||||
|
||||
|
||||
|
||||
|
||||
## ⚠️ Disclaimer
|
||||
## 免责声明
|
||||
|
||||
This project is for learning and communication purposes only. Users are responsible for any consequences of using this project.
|
||||
本项目仅供学习与交流使用。使用本项目所产生的任何后果由使用者自行承担。
|
||||
|
||||
## 🌟 Maintenance Notice
|
||||
## 维护说明
|
||||
|
||||
This project is currently under light maintenance. We will:
|
||||
- Fix critical bugs and security issues
|
||||
- Review and merge important pull requests
|
||||
- Provide necessary updates for compatibility
|
||||
本项目当前处于轻度维护状态。我们将：
|
||||
- 修复关键 bug 与安全问题
|
||||
- 审核并合并重要的 Pull Request
|
||||
- 提供必要的兼容性更新
|
||||
|
||||
However, new feature development may be limited.
|
||||
但新功能开发可能会相对有限。
|
||||
|
||||
## 🔔 Important Notes
|
||||
## 重要提示
|
||||
|
||||
1. Restart required after modifying admin path:
|
||||
1. 修改后台路径后需要重启：
|
||||
```bash
|
||||
docker compose restart
|
||||
```
|
||||
|
||||
2. For aaPanel installations, restart the Octane daemon process
|
||||
2. 使用 aaPanel 安装时，请重启 Octane 守护进程
|
||||
|
||||
## 🤝 Contributing
|
||||
## 参与贡献
|
||||
|
||||
Issues and Pull Requests are welcome to help improve the project.
|
||||
欢迎提交 Issue 和 Pull Request 来共同改进项目。
|
||||
|
||||
## 📈 Star History
|
||||
## Star 历史
|
||||
|
||||
[](https://starchart.cc/Micah123321/Xboard)
|
||||
|
||||
Reference in New Issue
Block a user