mirror of
https://github.com/cedar2025/Xboard.git
synced 2025-01-22 18:48:14 -05:00
87 lines
2.8 KiB
Markdown
87 lines
2.8 KiB
Markdown
# Xboard
|
||
|
||
<div align="center">
|
||
|
||
[](https://t.me/XboardOfficial)
|
||
|
||
|
||
[](LICENSE)
|
||
|
||
English | [简体中文](README_CN.md)
|
||
|
||
</div>
|
||
|
||
## 📖 Introduction
|
||
|
||
Xboard is a modern panel system built on Laravel 11, focusing on providing a clean and efficient user experience.
|
||
|
||
## ✨ Features
|
||
|
||
- 🚀 Built with Laravel 11 + 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
|
||
|
||
## 🚀 Quick Start
|
||
|
||
```bash
|
||
git clone -b compose --depth 1 https://github.com/cedar2025/Xboard && \
|
||
cd Xboard && \
|
||
docker compose run -it --rm \
|
||
-e ENABLE_SQLITE=true \
|
||
-e ENABLE_REDIS=true \
|
||
-e ADMIN_ACCOUNT=admin@demo.com \
|
||
web php artisan xboard:install && \
|
||
docker compose up -d
|
||
```
|
||
|
||
> After installation, visit: http://SERVER_IP:7001
|
||
> ⚠️ Make sure to save the admin credentials shown during installation
|
||
|
||
## <20><> 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.
|
||
|
||
### Deployment Guides
|
||
- [Deploy with 1Panel](./docs/zh-CN/installation/1panel.md)
|
||
- [Deploy with Docker Compose](./docs/zh-CN/installation/docker-compose.md)
|
||
- [Deploy with aaPanel](./docs/zh-CN/installation/aapanel.md)
|
||
- [Deploy with aaPanel + Docker](./docs/zh-CN/installation/aapanel-docker.md) (Recommended)
|
||
|
||
### Migration Guides
|
||
- [Migrate from v2board dev](./docs/zh-CN/migration/v2board-dev.md)
|
||
- [Migrate from v2board 1.7.4](./docs/zh-CN/migration/v2board-1.7.4.md)
|
||
- [Migrate from v2board 1.7.3](./docs/zh-CN/migration/v2board-1.7.3.md)
|
||
- [Migrate from v2board wyx2685](./docs/zh-CN/migration/v2board-wyx2685.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
|
||
|
||
## 📷 Preview
|
||
|
||
|
||
|
||
|
||
## ⚠️ Disclaimer
|
||
|
||
This project is for learning and communication purposes only. Users are responsible for any consequences of using this project.
|
||
|
||
## 🔔 Important Notes
|
||
|
||
1. Restart required after modifying admin path:
|
||
```bash
|
||
docker compose restart
|
||
```
|
||
|
||
2. For aaPanel installations, restart the Octane daemon process
|
||
|
||
## 🤝 Contributing
|
||
|
||
Issues and Pull Requests are welcome to help improve the project. |