BootstrapAdmin/README.md

171 lines
10 KiB
Markdown
Raw Normal View History

2019-06-18 09:37:49 +08:00
# BootstrapAdmin
<span>English</span> | <a href="README.zh-CN.md">中文</a>
---
2019-06-02 19:05:21 +08:00
##### Version & Coverage
[![Release](https://img.shields.io/endpoint.svg?logo=Groupon&logoColor=red&color=green&label=release&url=https://ba.zylweb.cn/api/Gitee/Releases)](https://gitee.com/LongbowEnterprise/BootstrapAdmin/releases)
2019-06-04 17:19:37 +08:00
[![Coveralls](https://img.shields.io/coveralls/github/ArgoZhang/BootstrapAdmin/master.svg?logo=ReverbNation&logoColor=green)](https://coveralls.io/github/ArgoZhang/BootstrapAdmin)
2019-06-02 19:05:21 +08:00
[![Codecov](https://img.shields.io/codecov/c/gh/argozhang/bootstrapadmin/master.svg?logo=codecov)](https://codecov.io/gh/argozhang/bootstrapadmin/branch/master)
2019-05-29 10:12:07 +08:00
2019-05-18 12:47:43 +08:00
##### Gitee
[![Appveyor build](https://img.shields.io/endpoint.svg?logo=appveyor&label=build&color=blueviolet&url=https://ba.zylweb.cn/api/Gitee/Builds?projName=bootstrapadmin-9m1jm)](https://ci.appveyor.com/project/ArgoZhang/bootstrapadmin-9m1jm)
2019-05-20 12:47:50 +08:00
[![Build Status](https://img.shields.io/appveyor/ci/ArgoZhang/bootstrapadmin-9m1jm/master.svg?logo=appveyor&label=maser)](https://ci.appveyor.com/project/ArgoZhang/bootstrapadmin-9m1jm)
2019-06-02 19:05:21 +08:00
[![Test](https://img.shields.io/appveyor/tests/ArgoZhang/bootstrapadmin-9m1jm/master.svg?logo=appveyor&)](https://ci.appveyor.com/project/ArgoZhang/bootstrapadmin-9m1jm/build/tests)
[![Issue Status](https://img.shields.io/endpoint.svg?logo=Groupon&logoColor=critical&label=issues&url=https://ba.zylweb.cn/api/Gitee/Issues)](https://gitee.com/LongbowEnterprise/BootstrapAdmin/issues)
[![Pull Status](https://img.shields.io/endpoint.svg?logo=Groupon&logoColor=green&color=success&label=pulls&url=https://ba.zylweb.cn/api/Gitee/Pulls)](https://gitee.com/LongbowEnterprise/BootstrapAdmin/pulls)
2019-05-18 12:47:43 +08:00
##### GitHub
[![Appveyor build](https://img.shields.io/endpoint.svg?logo=appveyor&label=build&color=blueviolet&url=https://ba.zylweb.cn/api/Gitee/Builds?projName=bootstrapadmin)](https://ci.appveyor.com/project/ArgoZhang/bootstrapadmin)
2019-05-20 12:47:50 +08:00
[![master status](https://img.shields.io/appveyor/ci/ArgoZhang/bootstrapadmin/master.svg?logo=appveyor&label=master)](https://ci.appveyor.com/project/ArgoZhang/bootstrapadmin/branch/master)
2019-06-02 19:05:21 +08:00
[![Test](https://img.shields.io/appveyor/tests/argozhang/bootstrapadmin/master.svg?logo=appveyor&)](https://ci.appveyor.com/project/ArgoZhang/bootstrapadmin/branch/master/tests)
2019-05-19 09:37:25 +08:00
[![Repo Size](https://img.shields.io/github/repo-size/ArgoZhang/BootstrapAdmin.svg?logo=github&logoColor=green&label=repo)](https://github.com/ArgoZhang/BootstrapAdmin)
[![Commit Date](https://img.shields.io/github/last-commit/ArgoZhang/BootstrapAdmin/master.svg?logo=github&logoColor=green&label=commit)](https://github.com/ArgoZhang/BootstrapAdmin)
## Introduce
Because the dependent on Bootstrap v4, so it is called **Bootstrap Admin**. This system can be integrated with asp.net and asp.net core applications. The database supports multiple databases at the same time. The detailed list is shown in the following **database** detailed list. Switching the data source only needs to change the configuration file without restarting the application. The configuration is simple and flexible. The UI front-end uses the popular Bootstrap framework layout, which is very compatible with mobile devices and adapts to almost all terminal devices in the current market. The system also has the feature of single background supporting multi-front desk, and provides the ability of **single sign-on (SSO)**.
2019-06-18 09:37:49 +08:00
### Notes
Bootstrap Admin does not require secondary development, but only integration with the front-end system. The front-end system model project is **Bootstrap. Client**
The original starting point of the project is to separate the privilege system from the business system. The project development focuses on functions. For detailed configuration instructions, please click on [View Documents](https://gitee.com/LongbowEnterprise/BootstrapAdmin/wikis/%E7%B3%BB%E7%BB%9F%E9%89B%86%E6%88%90).
### Features
1. Integration with Front-end Website through Configuration
2. Constructing Hierarchical Menu of Front-end System
3. Provide a single background to support multiple front-end application configurations
4. Provide single sign-on(SSO)
5. Integrated System Authentication and Authorization Module
6. Provide role, department, user, menu, foreground application authorization
Role Authorization to Users
Role-to-Menu Authorization
Role Authorization to Departments
Role-to-application authorization (multiple front-end applications share a back-end privilege management system)
Departments Authorize Users
7. Provide dictionary tables for personalized configuration of front-end websites
8. Fully responsive layout (supporting all mainstream devices such as computers, tablets, mobile phones, etc.)
9. Built-in multi-data source support, simple configuration and immediate effect without restart
10. Built-in data memory caching mechanism, page fast response
11. Built-in Data **Operation Log** and User **Log on**
2019-06-18 09:37:49 +08:00
### Advantage
1. The front-end system does not need to write login, authorization and authentication modules; it is only responsible for writing business modules.
2. Background system can be used directly without any secondary development.
2019-06-18 09:37:49 +08:00
3. Front-end and back-end systems are separated, which are different systems (domain name can be independent)
For more information, please click [wiki](https://gitee.com/LongbowEnterprise/BootstrapAdmin/wikis/项目介绍)
### Database
2019-05-01 16:46:24 +08:00
**MSSQL/Oracle/SQLite/MySql/MariaDB/Postgresql/Firebird/MsAccess/MongoDB**
### Browser
2019-06-02 19:05:21 +08:00
![chrome](https://img.shields.io/badge/chrome->%3D4.5-success.svg?logo=google%20chrome&logoColor=red)
![firefox](https://img.shields.io/badge/firefox->38-success.svg?logo=mozilla%20firefox&logoColor=red)
![edge](https://img.shields.io/badge/edge->%3D12-success.svg?logo=microsoft%20edge&logoColor=blue)
![ie](https://img.shields.io/badge/ie->%3D11-success.svg?logo=internet%20explorer&logoColor=blue)
![Safari](https://img.shields.io/badge/safari->%3D9-success.svg?logo=safari&logoColor=blue)
![Andriod](https://img.shields.io/badge/andriod->%3D4.4-success.svg?logo=android)
![oper](https://img.shields.io/badge/opera->%3D3.0-success.svg?logo=opera&logoColor=red)
2019-05-01 16:46:24 +08:00
```json
"browserslist": [
"Chrome >= 45",
"Firefox >= 38",
"Edge >= 12",
2019-06-02 19:05:21 +08:00
"Explorer >= 11",
2019-05-01 16:46:24 +08:00
"iOS >= 9",
"Safari >= 9",
"Android >= 4.4",
"Opera >= 30"
]
```
### Mobile
2019-06-02 19:05:21 +08:00
![ios](https://img.shields.io/badge/ios-supported-success.svg?logo=apple&logoColor=white)
![Andriod](https://img.shields.io/badge/andriod-suported-success.svg?logo=android)
![windows](https://img.shields.io/badge/windows-suported-success.svg?logo=windows&logoColor=blue)
2019-05-01 16:46:24 +08:00
| | **Chrome** | **Firefox** | **Safari** | **Android Browser & WebView** | **Microsoft Edge** |
| ------- | --------- | --------- | ------ | ------------------------- | -------------- |
| **iOS** | Supported | Supported | Supported | N/A | Supported |
2019-06-02 19:05:21 +08:00
| **Android** | Supported | Supported | N/A | Android v5.0+ supported | Supported |
2019-05-01 16:46:24 +08:00
| **Windows 10 Mobile** | N/A | N/A | N/A | N/A | Supported |
### Desktop
2019-06-02 19:05:21 +08:00
![macOS](https://img.shields.io/badge/macOS-supported-success.svg?logo=apple&logoColor=white)
![linux](https://img.shields.io/badge/linux-suported-success.svg?logo=linux&logoColor=white)
![windows](https://img.shields.io/badge/windows-suported-success.svg?logo=windows)
2019-05-01 16:46:24 +08:00
| | Chrome | Firefox | Internet Explorer | Microsoft Edge | Opera | Safari |
| ------- | --------- | --------- | ----------------- | -------------- | --------- | ------------- |
| Mac | Supported | Supported | N/A | N/A | Supported | Supported |
2019-06-02 19:05:21 +08:00
| Linux | Supported | Supported | N/A | N/A | N/A | N/A |
2019-05-01 16:46:24 +08:00
| Windows | Supported | Supported | Supported, IE10+ | Supported | Supported | Not supported |
## QQ Group
2019-06-02 19:05:21 +08:00
[![QQ](https://img.shields.io/badge/QQ-795206915-green.svg?logo=tencent%20qq&logoColor=red)](https://shang.qq.com/wpa/qunwpa?idkey=d381355e50ff91db410c3da3eadb081ba859f64c2877e86343f4709b171f28b8)
2019-05-01 16:46:24 +08:00
## Installation
1. Install .net core sdk [Offical website](http://www.microsoft.com/net/download)
2. Install Visual Studio IDE 2017 lastest [Offical website](https://visualstudio.microsoft.com/vs/getting-started/)
3. Git clone `git clone https://github.com/ArgoZhang/BootstrapAdmin.git`
4. Copy file `copy ./Scripts/Longbow.lic ./Bootstrap.Admin/bin/debug/netcoreap2.2/longbow.lic`
5. Login as Admin/123789
## Branchs
**master** Synchronized with Online Demo
**dev** env: windows + SQLite
**dev-AdminLTE** AdminLTE branch [Online Demo](http://ba.sdgxgz.com/BA/Admin/Index)
**dev-Tabs** Multiple tabs branch
**dev-Localization** support multiple language branch
## Online Demonstration
[![website1](https://img.shields.io/badge/website-http://ba.zylweb.cn-success.svg?logo=buzzfeed&logoColor=green)](http://ba.zylweb.cn)
2019-06-04 17:19:37 +08:00
[![website2](https://img.shields.io/badge/website-http://ba.sdgxgz.com-success.svg?logo=buzzfeed&logoColor=green)](http://ba.sdgxgz.com)
2019-05-01 16:46:24 +08:00
### Login
Administrator: Admin/123789
User: User/123789
2019-05-01 16:46:24 +08:00
## Docker Images
2019-06-02 19:05:21 +08:00
[![Docker](https://img.shields.io/docker/cloud/automated/argozhang/ba.svg?logo=docker&logoColor=success)](https://hub.docker.com/r/argozhang/ba)
[![Docker](https://img.shields.io/docker/cloud/build/argozhang/ba.svg?logo=docker&logoColor=success)](https://hub.docker.com/r/argozhang/ba/builds)
2019-05-29 10:12:07 +08:00
### Docker Hub
Mirror [Portal](https://hub.docker.com/r/argozhang/ba)
2019-06-02 19:05:21 +08:00
```bash
2019-05-29 10:12:07 +08:00
docker pull argozhang/ba
```
### Qiniu Cloud:
Mirror [Portal](https://hub.qiniu.com/store/argozhang/ba)
2019-06-02 19:05:21 +08:00
```bash
2019-05-29 10:12:07 +08:00
docker pull reg.qiniu.com/argozhang/ba
```
2019-05-01 16:46:24 +08:00
## Configurations
Detailed configuration instructions please click [wikis](https://gitee.com/LongbowEnterprise/BootstrapAdmin/wikis)
2019-05-01 16:46:24 +08:00
## Q&A
Please click [wikis](https://gitee.com/LongbowEnterprise/BootstrapAdmin/wikis/常见问题Q&A)
2019-05-01 16:46:24 +08:00
## License
2019-06-02 19:05:21 +08:00
[![Gitee license](https://img.shields.io/github/license/argozhang/bootstrapadmin.svg?logo=git&logoColor=red)](https://gitee.com/LongbowEnterprise/BootstrapAdmin/blob/master/LICENSE)
## GVP award
[View](https://images.gitee.com/uploads/images/2019/0516/124055_96cc9f8d_554725.png "GiteeGVP.png")
2019-05-01 16:46:24 +08:00
## Screenshots
2019-05-01 16:46:24 +08:00
Home
2019-05-01 16:46:24 +08:00
![Home](https://gitee.com/LongbowEnterprise/Pictures/raw/master/BootstrapAdmin/BA02-01.png "BAHome-01.png")
2019-05-01 16:46:24 +08:00
For more screenshots, Click [wiki](https://gitee.com/LongbowEnterprise/BootstrapAdmin/wikis)
2019-05-01 16:46:24 +08:00
## Contribution
2019-05-01 16:46:24 +08:00
1. Fork
2. Create Feat_xxx branch
3. Commit
4. Create Pull Request