Skip to content

docs: 重构并完善多语言 README 文档 #730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kanyxmo merged 1 commit into from
Jun 13, 2026
Merged

docs: 重构并完善多语言 README 文档 #730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
204 changes: 122 additions & 82 deletions README-en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,96 +1,134 @@
[中文](./README.md) | English | [日本語](README-ja.md)
# Project Introduction
[中文](./README.md) | English | [日本語](./README-ja.md)

<p align="center">
<img src="web/public/logo.svg" width="120" alt="logo" />
</p>
<p align="center">
<a href="https://www.mineadmin.com" target="_blank">Official Website</a> |
<a href="https://doc.mineadmin.com" target="_blank">Documentation</a> |
<a href="https://demo.mineadmin.com" target="_blank">Demo</a> |
<a href="https://hyperf.wiki/3.0/#/" target="_blank">Hyperf Official Docs</a>
</p>
# MineAdmin

## Project Introduction
<p align="center">
<img src="web/public/logo.svg" width="120" alt="MineAdmin Logo" />
</p>

There are many excellent PHP backend management systems, but I couldn’t find one based on Swoole that suited my needs.
So, I developed a backend management system. It can be used for website admin panels, CMS, CRM, OA, ERP, and more.
<p align="center">
<a href="https://www.mineadmin.com" target="_blank">Official Website</a> |
<a href="https://doc.mineadmin.com" target="_blank">Documentation</a> |
<a href="https://demo.mineadmin.com" target="_blank">Demo</a>
</p>

The backend system is built on the Hyperf framework. With an enterprise-level architecture, it easily supports startups and individuals in their early stages, delivering performance comparable to static languages with minimal server resources.
The frontend uses Vue3 + Vite4 + Pinia + Arco, adapting seamlessly to PC, mobile, and tablet devices.
MineAdmin is an out-of-the-box admin management system for quickly building website back offices, operation platforms, permission centers, internal management systems, CMS, CRM, OA, ERP, and other business applications.

If you find it useful, please give it a ⭐star—it would mean a lot to me and be a great encouragement!
Before using MineAdmin, please read the [Disclaimer](https://doc.mineadmin.com/guide/start/declaration.html) carefully and agree to its terms.
It includes the common capabilities needed by enterprise admin systems, such as organization management, users, permissions, menus, logs, attachments, and an app marketplace. You can use it directly to manage your business, or extend your own modules on top of it and spend more time on the business itself.

## Official Community
> QQ group for discussion and learning—please avoid spamming.
Before using MineAdmin, please read and agree to the [Disclaimer](https://www.mineadmin.com/about/declaration).

## What Can It Be Used For

- Build internal enterprise admin systems, such as basic management for employees, departments, positions, roles, and permissions.
- Build business operation platforms, such as content management, customer management, order management, workflow management, and report dashboards.
- Use it as the admin foundation for new projects, directly reusing common capabilities such as login, permissions, menus, logs, and attachment uploads.
- Use it as a plugin-based application platform, installing, uninstalling, or extending more business features through the app marketplace.
- Provide a unified admin experience for teams, including multilingual support, theme settings, layout switching, tabs, breadcrumbs, and watermarks.

## Built-in Features

### Accounts and Permissions

- User management: add, edit, delete, disable users, initialize passwords, assign roles, and more.
- Role management: assign menu permissions and button permissions by role, controlling what different users can access and operate.
- Menu management: maintain admin menus, routes, button permissions, external links, iframe pages, sorting, caching, and hidden status.
- Data permissions: configure visible data ranges by position or user, so different members only see data within their permission scope.
- Login authentication: provides admin login, token verification, permission checks, and current user information.

### Organization Structure

- Department management: maintain hierarchical structures for companies, institutions, teams, and other organizations.
- Position management: maintain positions under departments and assign users to corresponding positions.
- Leader management: set department leaders to track organizational relationships and management responsibilities.
- Member viewing: view related users by department and quickly understand member distribution across the organization.

### Logs and Audit

- Login logs: record user login time, login IP, browser, login status, and messages.
- Operation logs: record key user operations, request methods, accessed routes, business names, and operation times.
- Permission audit: combine roles, menus, buttons, and data permissions to help locate where a user's accessible resources come from.

### Data and Files

- Attachment management: centrally manage files, images, and other resources uploaded to the system.
- File upload: provides admin upload entry points and records uploader information, file details, and other data.
- Data center: provides a unified management entry for future business data, file resources, and extension modules.

### Application Extensions

- App marketplace: view apps, plugins, and frontend components, and download, install, or uninstall them as needed.
- Local apps: view locally installed apps and upload local app packages.
- Plugin extensions: suitable for packaging independent business capabilities as plugins, reducing changes to the main system.

### Admin Experience

- Workbench and dashboards: provides examples such as a workbench, analysis page, and report page as admin home pages.
- Personal center: supports common account operations such as profile maintenance and password changes.
- Multilingual support: includes Simplified Chinese, Traditional Chinese, English, and other language resources.
- Themes and layouts: supports light mode, dark mode, system mode, theme colors, classic layout, column layout, mixed layout, and more.
- Common interactions: includes tabs, breadcrumbs, fullscreen, search, notifications, shortcuts, watermarks, back-to-top, and other common admin experiences.

## Quick Start

MineAdmin uses migration files to install and initialize data. You do not need to manually import SQL files.

Please make sure `Composer` is installed locally, then run:

```shell
composer create-project mineadmin/mineadmin --keep-vcs
```

For complete installation, configuration, deployment, and development instructions, please see the [official documentation](https://doc.mineadmin.com).

## Demo Access

[Online Demo](https://demo.mineadmin.com)

- Username: `admin`
- Password: `123456`

> The demo environment is for trial use only. Please do not add irrelevant data.

## Requirements

- PHP >= 8.1
- Swoole >= 5.0, with `Short Name` disabled
- Redis >= 4.0
- MySQL >= 5.7 / PostgreSQL >= 10 / SQL Server
- Git >= 2.x

## Official Community

> The QQ group is for discussion and learning. Please avoid off-topic chatting.

<a href="https://qm.qq.com/q/PJnEgr4D8C">
<img src="https://svg.hamm.cn/badge.svg?key=QQ Group&value=150105478" />
<img src="https://svg.hamm.cn/badge.svg?key=QQ Group&value=150105478" />
</a>

## Strategic Partnership
[Jingcedun High-Protection CDN - Reliable Anti-DDoS/CC Attack Service](https://www.jcdun.com/guoneigaofangcdn)

## Built-in Features

1. **User Management**: Add, modify, and delete users; supports different homepages for different users.
2. **Role Management**: Assign menu permissions and data permissions to roles.
3. **Menu Management**: Configure system menus and buttons.
4. **Operation Logs**: Track and query user actions.
5. **Login Logs**: Record and query user login history.
6. **Attachment Management**: Manage uploaded files and images.
7. **App Market**: Download various basic apps, plugins, frontend components, and more.

## Requirements

- Swoole >= 5.0 (with `Short Name` disabled)
- PHP >= 8.1 with the following extensions enabled:
- mbstring
- json
- pdo
- openssl
- redis
- pcntl
- [x] MySQL >= 5.7
- [x] PostgreSQL >= 10
- [x] SQL Server (Latest)
- SQLSRV (Latest)
- Redis >= 4.0
- Git >= 2.x

## Download the Project
- MineAdmin does not use SQL file imports for installation. Instead, it uses Migrate files for setup and data seeding.

- To download the project (ensure `Composer` is installed):
```shell
composer create-project mineadmin/mineadmin --keep-vcs
```
## Strategic Partnership

## Disclaimer
[Disclaimer](https://doc.mineadmin.com/guide/start/declaration.html)
[Jingcedun High-Protection CDN - A reliable service provider against DDoS/CC network attacks](https://www.jcdun.com/guoneigaofangcdn)

This software must not be used to develop applications that violate national policies. `MineAdmin` bears no legal responsibility for any misuse.
## Disclaimer

## Demo Access
[Demo](https://demo.mineadmin.com)
- Username: **admin**
- Password: **123456**
[Disclaimer](https://doc.mineadmin.com/guide/start/declaration.html)

> Please avoid adding test data.
This software must not be used to develop software or applications that violate relevant national policies. Any legal responsibility caused by the use of this software has nothing to do with `MineAdmin`.

## Acknowledgments
## Acknowledgements

> Listed in no particular order
> Listed in no particular order.

[Hyperf - A high-performance enterprise coroutine framework](https://hyperf.io/)
[Element Plus - A Vue 3-based component library for designers and developers](https://element-plus.org/)
[Swoole - PHP coroutine framework](https://www.swoole.com)
[Hyperf](https://hyperf.io/)
[Element Plus](https://element-plus.org/)
[Swoole](https://www.swoole.com)
[Vue](https://vuejs.org/)
[Vite](https://vitejs.cn/)
[Jetbrains - Productivity tools](https://www.jetbrains.com/)
[JetBrains](https://www.jetbrains.com/)

## OSCS Security Certification

[![OSCS Status](https://www.oscs1024.com/platform/badge/kanyxmo/MineAdmin.svg?size=large)](https://www.murphysec.com/dr/9ztZvuSN6OLFjCDGVo)

## Star History
Expand All @@ -99,19 +137,21 @@ This software must not be used to develop applications that violate national pol

## Contributors

> Thanks to all contributors who helped develop MineAdmin. [[contributors](https://github.com/mineadmin/mineadmin/graphs/contributors)]
<a href="https://github.com/mineadmin/mineadmin/graphs/contributors">
<img src="https://contrib.rocks/image?repo=mineadmin/mineadmin" />
> Thanks to all code contributors who participated in the development of MineAdmin. [[contributors](https://github.com/mineadmin/mineadmin/graphs/contributors)]

<a href="https://github.com/mineadmin/mineadmin/graphs/contributors">
<img src="https://contrib.rocks/image?repo=mineadmin/mineadmin" />
</a>

[![Contributor Trends](https://contributor-overtime-api.apiseven.com/contributors-svg?chart=contributorOverTime&repo=mineadmin/mineadmin)](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=mineadmin/mineadmin)

## Demo Screenshots
[![pAdQKPJ.png](https://s21.ax1x.com/2024/10/22/pAdQKPJ.png)](https://imgse.com/i/pAdQKPJ)
[![pAdQlx1.png](https://s21.ax1x.com/2024/10/22/pAdQlx1.png)](https://imgse.com/i/pAdQlx1)
[![pAdQQ2R.png](https://s21.ax1x.com/2024/10/22/pAdQQ2R.png)](https://imgse.com/i/pAdQQ2R)
[![pAdQGqK.png](https://s21.ax1x.com/2024/10/22/pAdQGqK.png)](https://imgse.com/i/pAdQGqK)
[![pAdQYVO.png](https://s21.ax1x.com/2024/10/22/pAdQYVO.png)](https://imgse.com/i/pAdQYVO)
[![pAdQNIe.png](https://s21.ax1x.com/2024/10/22/pAdQNIe.png)](https://imgse.com/i/pAdQNIe)
[![pAdQaPH.png](https://s21.ax1x.com/2024/10/22/pAdQaPH.png)](https://imgse.com/i/pAdQaPH)

[![pAdQKPJ.png](https://s21.ax1x.com/2024/10/22/pAdQKPJ.png)](https://imgse.com/i/pAdQKPJ)
[![pAdQlx1.png](https://s21.ax1x.com/2024/10/22/pAdQlx1.png)](https://imgse.com/i/pAdQlx1)
[![pAdQQ2R.png](https://s21.ax1x.com/2024/10/22/pAdQQ2R.png)](https://imgse.com/i/pAdQQ2R)
[![pAdQGqK.png](https://s21.ax1x.com/2024/10/22/pAdQGqK.png)](https://imgse.com/i/pAdQGqK)
[![pAdQYVO.png](https://s21.ax1x.com/2024/10/22/pAdQYVO.png)](https://imgse.com/i/pAdQYVO)
[![pAdQNIe.png](https://s21.ax1x.com/2024/10/22/pAdQNIe.png)](https://imgse.com/i/pAdQNIe)
[![pAdQaPH.png](https://s21.ax1x.com/2024/10/22/pAdQaPH.png)](https://imgse.com/i/pAdQaPH)
[![pAdQdGd.png](https://s21.ax1x.com/2024/10/22/pAdQdGd.png)](https://imgse.com/i/pAdQdGd)
Loading
Loading