diff --git a/README-en.md b/README-en.md index deec0d6f..e5a8e0a0 100644 --- a/README-en.md +++ b/README-en.md @@ -1,96 +1,134 @@ -[中文](./README.md) | English | [日本語](README-ja.md) -# Project Introduction +[中文](./README.md) | English | [日本語](./README-ja.md) -

- logo -

-

- Official Website | - Documentation | - Demo | - Hyperf Official Docs -

+# MineAdmin -## Project Introduction +

+ MineAdmin Logo +

-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. +

+ Official Website | + Documentation | + Demo +

-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. - + -## 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 @@ -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)] - - +> Thanks to all code contributors who participated in the development of MineAdmin. [[contributors](https://github.com/mineadmin/mineadmin/graphs/contributors)] + + + [![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) diff --git a/README-ja.md b/README-ja.md index 1288d04e..38a134da 100644 --- a/README-ja.md +++ b/README-ja.md @@ -1,118 +1,152 @@ [中文](./README.md) | [English](./README-en.md) | 日本語 -# プロジェクト紹介 + +# MineAdmin

- logo + MineAdmin Logo

+

公式サイト | - ドキュメント | - デモ | - Hyperf公式ドキュメント + ドキュメント | + デモ

-## プロジェクト紹介 +MineAdmin は、Web サイトの管理画面、運営プラットフォーム、権限センター、社内管理システム、CMS、CRM、OA、ERP などの業務アプリケーションをすばやく構築するための、すぐに使えるバックエンド管理システムです。 -PHPには多くの優れた管理システムがありますが、Swooleベースの管理システムで自分に適したものが見つかりませんでした。 -そこで、新しい管理システムを開発しました。このシステムは、ウェブサイト管理、CMS、CRM、OA、ERPなどに利用できます。 +組織、ユーザー、権限、メニュー、ログ、添付ファイル、アプリマーケットなど、企業向け管理画面でよく使われる機能をあらかじめ備えています。そのまま業務管理に利用することも、独自モジュールを拡張して、より多くの時間を業務そのものに集中することもできます。 -管理システムはHyperfフレームワークベースで開発されています。エンタープライズレベルのアーキテクチャ設計により、スタートアップ企業や個人の初期発展を簡単にサポートし、少ないサーバーリソースで静的言語に匹敵するパフォーマンスを実現します。 -フロントエンドはVue3 + Vite4 + Pinia + Arcoを使用し、PC、モバイル、タブレットに対応します。 +MineAdmin を使用する前に、必ず[《免責事項》](https://www.mineadmin.com/about/declaration)をお読みいただき、同意してください。 -もし気に入っていただけましたら、⭐starで応援してください。これが私にとって最大の支援と励みになります! -MineAdminをご利用になる前に、[《免責事項》](https://doc.mineadmin.com/guide/start/declaration.html)を必ずお読みいただき、同意してください。 +## 何に使えるか -## 公式交流グループ -> QQグループは学習交流用です。無駄話はご遠慮ください +- 社内管理画面の構築。社員、部門、役職、ロール、権限などの基本管理に利用できます。 +- 業務運営プラットフォームの構築。コンテンツ管理、顧客管理、注文管理、ワークフロー管理、レポートダッシュボードなどに利用できます。 +- 新規プロジェクトの管理画面基盤として利用し、ログイン、権限、メニュー、ログ、添付ファイルアップロードなどの共通機能をそのまま再利用できます。 +- プラグイン型アプリケーションプラットフォームとして利用し、アプリマーケットから業務機能をインストール、アンインストール、拡張できます。 +- 多言語、テーマ設定、レイアウト切り替え、タブ、パンくず、ウォーターマークなど、チーム向けの統一された管理画面体験を提供できます。 - - - +## 内蔵機能 -## 戦略パートナー -[京策盾高防CDN - DDoS/CC攻撃に対抗する信頼できるサービスプロバイダー](https://www.jcdun.com/guoneigaofangcdn) +### アカウントと権限 -## 内蔵機能 +- ユーザー管理:ユーザーの追加、編集、削除、無効化、パスワード初期化、ロール割り当てなどに対応します。 +- ロール管理:ロールごとにメニュー権限とボタン権限を割り当て、ユーザーごとのアクセス範囲と操作範囲を制御できます。 +- メニュー管理:管理画面メニュー、ルート、ボタン権限、外部リンク、iframe ページ、並び順、キャッシュ、非表示状態などを管理できます。 +- データ権限:役職またはユーザーごとにデータの表示範囲を設定し、メンバーごとに権限内のデータだけを表示できます。 +- ログイン認証:管理画面ログイン、トークン検証、権限検証、現在のユーザー情報取得機能を提供します。 -1. ユーザー管理:ユーザーの追加、編集、削除設定を完了し、異なるユーザーがログイン後に異なるホームページを表示することをサポート -2. ロール管理:ロールメニュー権限の割り当て、ロールデータ権限の割り当て -3. メニュー管理:システムメニューとボタンなどの設定 -4. 操作ログ:ユーザーのシステムに対する正常な操作の照会 -5. ログインログ:ユーザーのシステムログイン記録の照会 -6. 添付ファイル管理:現在のシステムにアップロードされたファイルや画像などの情報管理 -7. アプリケーションマーケット:様々な基本アプリケーション、プラグイン、フロントエンドコンポーネントなどをダウンロード可能 +### 組織構造 -## 環境要件 +- 部門管理:会社、機関、チームなどの階層型組織構造を管理できます。 +- 役職管理:部門配下の役職を管理し、ユーザーを対応する役職に割り当てられます。 +- 責任者管理:部門責任者を設定し、組織関係と管理責任を追跡しやすくします。 +- メンバー確認:部門に紐づくユーザーを確認し、組織内のメンバー分布をすばやく把握できます。 -- Swoole >= 5.0 かつ `Short Name` を無効化 -- PHP >= 8.1 かつ以下の拡張機能を有効化: - - mbstring - - json - - pdo - - openssl - - redis - - pcntl -- [x] Mysql >= 5.7 -- [x] Pgsql >= 10 -- [x] Sql Server Latest -- Sqlsrv is Latest -- Redis >= 4.0 -- Git >= 2.x +### ログ監査 -## プロジェクトのダウンロード -- MineAdminはSQLファイルのインポートインストールを使用せず、システムはMigratesマイグレーションファイル形式でインストールとデータ入力を行います。ご了承ください。 +- ログインログ:ユーザーのログイン時刻、ログイン IP、ブラウザ、ログイン状態、メッセージを記録します。 +- 操作ログ:ユーザーの重要操作、リクエスト方式、アクセスルート、業務名、操作時刻を記録します。 +- 権限監査:ロール、メニュー、ボタン、データ権限を組み合わせ、ユーザーがアクセス可能なリソースの由来を確認しやすくします。 + +### データとファイル + +- 添付ファイル管理:システムにアップロードされたファイル、画像などのリソースを一元管理できます。 +- ファイルアップロード:管理画面からのアップロード入口を提供し、アップロード者、ファイル情報などを記録します。 +- データセンター:今後の業務データ、ファイルリソース、拡張モジュールのための統一管理入口を提供します。 + +### アプリ拡張 + +- アプリマーケット:アプリ、プラグイン、フロントエンドコンポーネントを確認し、必要に応じてダウンロード、インストール、アンインストールできます。 +- ローカルアプリ:ローカルにインストール済みのアプリを確認でき、ローカルアプリパッケージのアップロードにも対応します。 +- プラグイン拡張:独立した業務機能をプラグインとしてパッケージ化し、メインシステムへの変更を減らす用途に適しています。 + +### 管理画面体験 + +- ワークベンチとダッシュボード:ワークベンチ、分析ページ、レポートページなど、管理画面ホームの例を提供します。 +- 個人センター:プロフィール管理、パスワード変更など、よく使うアカウント操作に対応します。 +- 多言語:簡体字中国語、繁体字中国語、英語などの言語リソースを内蔵しています。 +- テーマとレイアウト:ライトモード、ダークモード、システム連動、テーマカラー、クラシックレイアウト、カラムレイアウト、ミックスレイアウトなどに対応します。 +- 共通インタラクション:タブ、パンくず、全画面表示、検索、通知、ショートカット、ウォーターマーク、トップへ戻るなど、管理画面でよく使う体験を備えています。 + +## クイックスタート + +MineAdmin はマイグレーションファイルを使ってインストールと初期データ作成を行います。SQL ファイルを手動でインポートする必要はありません。 + +まず、ローカルに `Composer` がインストールされていることを確認し、次のコマンドを実行してください。 -- プロジェクトダウンロード前に、`Composer`がインストールされていることを確認してください ```shell composer create-project mineadmin/mineadmin --keep-vcs ``` -## 免責事項 -[《免責事項》](https://doc.mineadmin.com/guide/start/declaration.html) +インストール、設定、デプロイ、開発に関する詳しい説明は、[公式ドキュメント](https://doc.mineadmin.com)をご覧ください。 -本ソフトウェアは国家関連政策に違反する関連ソフトウェアやアプリケーションの開発に使用してはいけません。本ソフトウェアの使用により生じたすべての法的責任は`MineAdmin`とは無関係です。 +## デモ -## デモサイト +[オンラインデモ](https://demo.mineadmin.com) -[デモサイト](https://demo.mineadmin.com) -- アカウント:admin -- パスワード:123456 +- アカウント:`admin` +- パスワード:`123456` -> 不正なデータの追加はお控えください +> デモ環境は体験用です。無関係なデータを追加しないでください。 -## 謝辞 +## 環境要件 -> 以下の順序は特に意味がありません +- PHP >= 8.1 +- Swoole >= 5.0、かつ `Short Name` を無効化 +- Redis >= 4.0 +- MySQL >= 5.7 / PostgreSQL >= 10 / SQL Server +- Git >= 2.x -[Hyperf 高性能エンタープライズレベル協調フレームワーク](https://hyperf.io/) +## 公式コミュニティ -[Element Plus Vue 3ベース、デザイナーと開発者向けコンポーネントライブラリ](https://element-plus.org/) +> QQ グループは交流と学習のためのものです。無関係な雑談はお控えください。 -[Swoole PHP協調フレームワーク](https://www.swoole.com) + + + -[Vue](https://vuejs.org/) +## 戦略パートナー -[Vite](https://vitejs.cn/) +[Jingcedun 高防御 CDN - DDoS/CC ネットワーク攻撃に対抗する信頼できるサービスプロバイダー](https://www.jcdun.com/guoneigaofangcdn) -[Jetbrains 生産性ツール](https://www.jetbrains.com/) +## 免責事項 + +[《免責事項》](https://doc.mineadmin.com/guide/start/declaration.html) + +本ソフトウェアを、国の関連政策に違反するソフトウェアまたはアプリケーションの開発に使用してはなりません。本ソフトウェアの使用によって生じたいかなる法的責任も、`MineAdmin` とは関係ありません。 + +## 謝辞 + +> 以下は順不同です。 + +[Hyperf](https://hyperf.io/) +[Element Plus](https://element-plus.org/) +[Swoole](https://www.swoole.com) +[Vue](https://vuejs.org/) +[Vite](https://vitejs.cn/) +[JetBrains](https://www.jetbrains.com/) + +## OSCS セキュリティ認証 -## OSCS セキュリティ認証を通過 [![OSCS Status](https://www.oscs1024.com/platform/badge/kanyxmo/MineAdmin.svg?size=large)](https://www.murphysec.com/dr/9ztZvuSN6OLFjCDGVo) -## star 傾向 +## Star 推移 [![Stargazers over time](https://starchart.cc/mineadmin/mineadmin.svg)](https://starchart.cc/mineadmin/mineadmin.svg) -## 貢献者 +## コントリビューター + +> MineAdmin の開発に参加してくださったすべてのコードコントリビューターに感謝します。[[contributors](https://github.com/mineadmin/mineadmin/graphs/contributors)] -> MineAdmin開発に参加したすべてのコード貢献者に感謝します。 [[contributors](https://github.com/mineadmin/mineadmin/graphs/contributors)] - + -[![貢献者傾向](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) +[![コントリビューター推移](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) ## デモ画像 + [![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) diff --git a/README.md b/README.md index c4706d77..b983d711 100644 --- a/README.md +++ b/README.md @@ -1,122 +1,152 @@ 中文 | [English](./README-en.md) | [日本語](./README-ja.md) -# 项目介绍 + +# MineAdmin

- logo + MineAdmin Logo

+

官网 | - 文档 | - 演示 | - Hyperf官方文档 + 文档 | + 演示

-## 项目介绍 +MineAdmin 是一套开箱即用的后台管理系统,适合快速搭建网站后台、运营平台、权限中心、内部管理系统、CMS、CRM、OA、ERP 等业务应用。 -PHP有很多优秀的后台管理系统,但基于Swoole的后台管理系统没找到合适我自己的。 -所以就开发了一套后台管理系统。系统可以用于网站管理后台、CMS、CRM、OA、ERP等。 +它已经内置了企业后台常用的组织、用户、权限、菜单、日志、附件、应用市场等能力。你可以直接用它管理业务,也可以在它的基础上扩展自己的模块,把更多时间放在业务本身。 -后台系统基于 Hyperf 框架开发。企业级架构分层,轻松支撑创业公司及个人前期发展使用,使用少量的服务器资源媲美静态语言的性能。 -前端使用Vue3 + Vite4 + Pinia + Arco,一端适配PC、移动端、平板 +在使用 MineAdmin 前,请认真阅读并同意[《免责声明》](https://www.mineadmin.com/about/declaration)。 -如果觉着还不错的话,就请点个 ⭐star 支持一下吧,这将是对我最大的支持和鼓励! -在使用 MineAdmin 前请认真阅读[《免责声明》](https://doc.mineadmin.com/guide/start/declaration.html)并同意该声明。 +## 适合用来做什么 -## 官方交流群 -> QQ群用于交流学习,请勿水群 +- 搭建企业内部管理后台,例如人员、部门、岗位、角色、权限等基础管理。 +- 搭建业务运营平台,例如内容管理、客户管理、订单管理、流程管理、报表看板等。 +- 作为新项目的后台基础工程,直接复用登录、权限、菜单、日志、附件上传等通用能力。 +- 作为插件化应用平台,通过应用市场安装、卸载或扩展更多业务功能。 +- 为团队提供统一的后台体验,包括多语言、主题配置、布局切换、标签页、面包屑、水印等界面能力。 - - - +## 内置功能 -## 战略合作 -[京策盾高防CDN - 抗DDOS/CC网络攻击的可靠服务商](https://www.jcdun.com/guoneigaofangcdn) +### 账号与权限 -## 内置功能 +- 用户管理:支持用户新增、编辑、删除、禁用、初始化密码、分配角色等操作。 +- 角色管理:按角色分配菜单权限和按钮权限,控制不同人员可访问、可操作的范围。 +- 菜单管理:维护后台菜单、路由、按钮权限、外链、iframe 页面、排序、缓存、隐藏状态等。 +- 数据权限:可按岗位或用户设置数据可见范围,让不同成员只看到自己权限内的数据。 +- 登录认证:提供后台登录、令牌校验、权限校验和当前用户信息获取能力。 -1. 用户管理,完成用户添加、修改、删除配置,支持不同用户登录后台看到不同的首页 -2. 角色管理,角色菜单权限分配、角色数据权限分配 -3. 菜单管理,配置系统菜单和按钮等 -4. 操作日志,用户对系统的一些正常操作的查询 -5. 登录日志,用户登录系统的记录查询 -6. 附件管理,管理当前系统上传的文件及图片等信息 -7. 部门管理,可以管理组织架构 -8. 岗位管理,在部门内管理,可以为部门设置岗位,再为用户分配岗位 -9. 数据权限,数据权限功能跟随岗位而设置,同时,也可以对用户单独设置数据权限,使岗位的数据权限失效。 -10. 应用市场,可下载各种基础应用、插件、前端组件等等 - -## 环境需求 - -- Swoole >= 5.0 并关闭 `Short Name` -- PHP >= 8.1 并开启以下扩展: - - mbstring - - json - - pdo - - openssl - - redis - - pcntl -- [x] Mysql >= 5.7 -- [x] Pgsql >= 10 -- [x] Sql Server Latest -- Sqlsrv is Latest -- Redis >= 4.0 -- Git >= 2.x +### 组织架构 + +- 部门管理:维护公司、机构、团队等层级组织结构。 +- 岗位管理:在部门下维护岗位,并将用户分配到对应岗位。 +- 负责人管理:可为部门设置负责人,便于组织关系和管理责任追踪。 +- 人员查看:可围绕部门查看关联用户,快速了解组织成员分布。 +### 日志审计 -## 下载项目 -- MineAdmin没有使用SQL文件导入安装,系统使用Migrates迁移文件形式安装和填充数据,请知悉。 +- 登录日志:记录用户登录时间、登录 IP、浏览器、登录状态和提示信息。 +- 操作日志:记录用户在系统中的关键操作、请求方式、访问路由、业务名称和操作时间。 +- 权限审计:结合角色、菜单、按钮和数据权限,帮助定位用户可访问资源来源。 + +### 数据与文件 + +- 附件管理:统一管理系统上传的文件、图片等资源。 +- 文件上传:提供后台上传入口,并记录上传人、文件信息等数据。 +- 数据中心:为后续业务数据、文件资源和扩展模块提供统一管理入口。 + +### 应用扩展 + +- 应用市场:支持查看应用、插件和前端组件,按需下载、安装、卸载。 +- 本地应用:支持查看本地已安装应用,也可以上传本地应用包。 +- 插件扩展:适合把独立业务能力封装成插件,减少主系统改动。 + +### 后台体验 + +- 工作台与数据看板:提供工作台、分析页、报表页等后台首页示例。 +- 个人中心:支持个人资料维护、密码修改等常用账户操作。 +- 多语言:内置简体中文、繁体中文、英文等语言资源。 +- 主题与布局:支持亮色、暗色、跟随系统、主题色、经典布局、分栏布局、混合布局等配置。 +- 常用交互:内置标签页、面包屑、全屏、搜索、通知、快捷入口、水印、返回顶部等后台常见体验。 + +## 快速开始 + +MineAdmin 使用迁移文件完成安装和初始化数据,不需要手动导入 SQL 文件。 + +请先确保本地已安装 `Composer`,然后执行: -- 项目下载,请确保已经安装了 `Composer` ```shell composer create-project mineadmin/mineadmin --keep-vcs ``` -## 免责声明 -[《免责声明》](https://doc.mineadmin.com/guide/start/declaration.html) - -使用本软件不得用于开发违反国家有关政策的相关软件和应用,若因使用本软件造成的一切法律责任均与 `MineAdmin` 无关 +更完整的安装、配置、部署和开发说明,请查看[官方文档](https://doc.mineadmin.com)。 ## 体验地址 -[体验地址](https://demo.mineadmin.com) -- 账号:admin -- 密码:123456 +[在线演示](https://demo.mineadmin.com) -> 请勿添加脏数据 +- 账号:`admin` +- 密码:`123456` -## 鸣谢 +> 演示环境供体验使用,请勿添加无关数据。 -> 以下排名不分先后 +## 环境要求 -[Hyperf 一款高性能企业级协程框架](https://hyperf.io/) +- PHP >= 8.1 +- Swoole >= 5.0,并关闭 `Short Name` +- Redis >= 4.0 +- MySQL >= 5.7 / PostgreSQL >= 10 / SQL Server +- Git >= 2.x -[Element Plus 基于 Vue 3,面向设计师和开发者的组件库](https://element-plus.org/) +## 官方交流 -[Swoole PHP协程框架](https://www.swoole.com) +> QQ 群用于交流学习,请勿水群。 -[Vue](https://vuejs.org/) + + + -[Vite](https://vitejs.cn/) +## 战略合作 -[Jetbrains 生产力工具](https://www.jetbrains.com/) +[京策盾高防 CDN - 抗 DDOS/CC 网络攻击的可靠服务商](https://www.jcdun.com/guoneigaofangcdn) + +## 免责声明 + +[《免责声明》](https://doc.mineadmin.com/guide/start/declaration.html) + +使用本软件不得用于开发违反国家有关政策的相关软件和应用。若因使用本软件造成任何法律责任,均与 `MineAdmin` 无关。 + +## 鸣谢 + +> 以下排名不分先后。 + +[Hyperf](https://hyperf.io/) +[Element Plus](https://element-plus.org/) +[Swoole](https://www.swoole.com) +[Vue](https://vuejs.org/) +[Vite](https://vitejs.cn/) +[JetBrains](https://www.jetbrains.com/) ## 通过 OSCS 安全认证 + [![OSCS Status](https://www.oscs1024.com/platform/badge/kanyxmo/MineAdmin.svg?size=large)](https://www.murphysec.com/dr/9ztZvuSN6OLFjCDGVo) -## star 趋势 +## Star 趋势 [![Stargazers over time](https://starchart.cc/mineadmin/mineadmin.svg)](https://starchart.cc/mineadmin/mineadmin.svg) ## 贡献者 -> 感谢所有参与 MineAdmin 开发的代码贡献者。 [[contributors](https://github.com/mineadmin/mineadmin/graphs/contributors)] +> 感谢所有参与 MineAdmin 开发的代码贡献者。[[contributors](https://github.com/mineadmin/mineadmin/graphs/contributors)] + - + [![贡献者趋势](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) ## 演示图片 + [![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)