提交 50a43c2c 编写于 作者: X xiongchun

更新开发文档

上级 9b3324e7
......@@ -13,7 +13,7 @@ slug: /intro
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
**盘古 Admin** 是一套基于 **SCUI**(Vue3、Element-Plus) + **盘古开发框架**的中后台业务系统前后端统一解决方案。并预置了轻量成熟的 [权限系统参考实现](https://pangu-admin.pulanit.com),用户可以基于此快速搭建中后台业务系统二次开发脚手架。
**盘古 Admin** 是一套基于 **SCUI**(Vue3、Element-Plus) + **盘古服务开发框架**的中后台业务系统前后端统一解决方案。并预置了轻量成熟的 [权限系统参考实现](https://pangu-admin.pulanit.com),用户可以基于此快速搭建中后台业务系统二次开发脚手架。
## 前端方案介绍
盘古 Admin 前端基于 SUCI 开发。SCUI 是一个中后台前端解决方案,基于 VUE3 和 ElementPlus 实现。 使用最新的前端技术栈,提供各类实用的组件方便在业务开发时的调用,并且持续性的提供丰富的业务模板帮助你快速搭建企业级中后台前端任务。更多 SCUI 信息,请直接参考其 项目主页和相关文档。
......
......@@ -6,24 +6,11 @@ slug: /intro
---
<head>
<title>盘古框架文档 | 盘古开发框架简介</title>
<title>盘古框架文档 | 盘古服务开发框架简介</title>
<meta name="keywords" content="盘古框架文档 | 盘古开发框架简介" />
</head>
export const Highlight = ({children, color}) => (
<span
style={{
backgroundColor: color,
borderRadius: '3px',
color: '#fff',
padding: '0.1rem',
margin: '0.2rem'
}}>
{children}
</span>
);
[**盘古开发框架**](/) 是一套轻量稳健的工业级 Web 接口服务和中后台业务系统开发框架。原生支持微服务分布式架构的同时也兼容单体应用架构模式。基于商业友好的 [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)协议<Highlight color="#25c2a0">免费开源</Highlight>发布。我们希望不仅是开源的受益者也能成为开源贡献者,与开源社区一起**共建共享开源生态**
[盘古服务开发框架](/docs/intro)(PanGu Service Framework)以 Dubbo、Nacos 和 Spring Boot 为核心架构,可在云原生时代构建以「服务」为中心的现代应用架构,帮助用户在云环境中更好的构建、交付和管理自己的微服务平台(也兼容支持垂直单体分层架构开发模式)。
## 设计原则
......@@ -46,17 +33,6 @@ export const Highlight = ({children, color}) => (
src={require('/resources/doc/34-pangu-framework.png').default}
alt="盘古开发框架生态架构图" />
## 特性一览
- **开箱即用、轻量灵活**
开箱即用的技术组件库,可随意组合、自动装配。轻量灵活的 [权限系统参考实现](/online-demo) ,可实现快速搭建二次开发脚手架的能力。同时支持大并发易扩展的高可用分布式架构也能快速组装成垂直单体分层架构。
- **成熟架构、稳定可靠**
盘古技术栈融合云原生思想,在微服务、容器化、DevOps 等方面完美支持和适配。可在云原生时代构建以「服务」为中心的现代应用架构,帮助用户在云环境中更好的构建、交付和管理自己的微服务平台。
- **全栈百搭适配各类业务场景**
聚焦面向(移动)互联网的电商、金融、云端 SAAS 服务等大并发高可用可扩展的业务场景。 同时也能满足诸如 ERP 、CRM 等各种企业数字化和各级电子政务系统的中小规模应用需求。
## 主要功能
1. 自定义的 Spring Boot 启动器,完成各功能组件的自动装配。
......@@ -72,7 +48,6 @@ export const Highlight = ({children, color}) => (
11. 提供分布式环境下的多级缓存功能(注解式和编程式)。Caffeine 作为一级本地缓存,Redis 作为二级集中式缓存。
12. 支持可配置、可监控的分布式任务调度。
13. 支持注解声明式和编程式对业务代码在分布式环境下加并发互斥锁。
14. 提供成熟的中后台业务系统二次开发脚手架(含前后端和 [权限系统参考实现](/online-demo) )。<Highlight color="#F56C6C">HOT</Highlight>
14. 应用日志输出级别动态切换、分布式日志跟踪等...
## 组件依赖
......@@ -127,17 +102,9 @@ export const Highlight = ({children, color}) => (
盘古数据治理(读写分离、数据分片等)自动装配模块
- **pangu-generator-maven-plugin**
盘古代码生成器Maven插件
- **pangu-admin** <Highlight color="#F56C6C">HOT</Highlight>
盘古中后台业务系统二次开发脚手架(含前后端和 [权限系统参考实现](/online-demo)
- **pangu-website**
盘古项目官网和文档
- **pangu-examples**
盘古框架模版化参考范例集
## FAQ
你最想了解的常见问答可能都在这里:[:soon: 常见问答 FAQ](/faq/misc)
## 下一步
继续阅读其它章节获取你想要的答案或通过我们的 [开发者社区](/community) 寻求更多帮助。
......@@ -12,7 +12,7 @@ slug: /install
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
盘古开发框架已经发布到 Maven 中央仓库,直接使用如下方法安装使用即可。
盘古服务开发框架已经发布到 Maven 中央仓库,直接使用如下方法安装使用即可。
## 依赖管理模块
盘古资源依赖声明管理模块。所有盘古引用都应该依赖这个模块。
......
......@@ -12,5 +12,8 @@ slug: /faq-service
#### 1. 盘古服务开发框架和 [Spring Cloud](https://spring.io/projects/spring-cloud) 或 [Spring Cloud Alibaba](https://spring.io/projects/spring-cloud-alibaba) 是什么关系?
没有直接关系。「盘古开发框架」直接基于阿里的 Nacos、Seata、Sentinel 和 Apache 的 Dubbo、ShardingSphere 等分布式中间件输出微服务架构的能力。是一套完全独立于 Spring Cloud 生态的轻量灵活、成熟可靠的工业级分布式微服务开发和治理框架。相较于 SC 和 SCA 而言,简单、纯洁、不被污染和绑架、易扩展好维护是其显著特点。
#### 2. 盘古服务开发框架可以做单体开发吗?
可以。从纯技术角度看,盘古服务开发的最佳姿势是 [分布式微服务开发](/docs/quick-start/how-to-make-microservice-architecture-app),但也支持搭建 [垂直单体分层架构的开发模式](/docs/quick-start/how-to-make-monomer-architecture-app)
## 下一步
继续阅读其它章节获取你想要的答案或通过我们的 [开发者社区](/community) 寻求更多帮助。
\ No newline at end of file
......@@ -6,8 +6,8 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */
const config = {
title: '盘古开发框架项目官网:一套轻量稳健的工业级 Web 接口服务应用和中后台业务系统开发框架',
tagline: '一套轻量稳健的工业级 Web 接口服务应用和中后台业务系统开发框架',
title: '盘古开发框架项目官网:一套轻量稳健的工业级行业数字化赋能开发框架',
tagline: '一套轻量稳健的工业级行业数字化赋能开发框架',
url: 'https://pangu.pulanit.com',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',
......@@ -122,6 +122,10 @@ const config = {
src: 'img/logo.svg',
},
items: [{
to: '/intro',
label: '简介',
position: 'left'
},{
type: 'doc',
docId: 'intro',
position: 'left',
......@@ -152,11 +156,6 @@ const config = {
}
],
},
{
href: '/faq',
label: '常见问答',
position: 'left',
},
{
to: '/thanks',
label: '致敬',
......@@ -233,7 +232,7 @@ const config = {
}
],
copyright: `PanGu Dev Framework is Open Source and freely available under the <a target="_blank" class="ghostwhite" href="https://www.apache.org/licenses/LICENSE-2.0">Apache v2 License.</a>
<br>Copyright © ${new Date().getFullYear()} <a target="_blank" class="ghostwhite" href="https://www.pulanit.com">PuLan Open Source Community</a><br>滇ICP备 2022001611 号<br><img src="https://pangu.pulanit.com/img/dashi.gif" />`,
<br>Copyright © ${new Date().getFullYear()} <a target="_blank" class="ghostwhite" href="https://www.pulanit.com">PuLan Open Source Community</a><br><img src="https://pangu.pulanit.com/img/dashi.gif" />`,
},
prism: {
theme: lightCodeTheme,
......
......@@ -4,20 +4,20 @@ import styles from './HomepageFeatures.module.css';
const FeatureList = [
{
title: '开箱即用、轻量灵活',
title: '免费开源、自主可控',
Svg: require('../../static/img/plugins.svg').default,
description: (
<>
开箱即用的技术组件库可随意组合自动装配轻量灵活的 <a href='online-demo'>权限系统参考实现</a> ,可实现快速搭建二次开发脚手架的能力。同时支持大并发易扩展的高可用分布式架构也能快速组装成垂直单体分层架构
盘古开发框架基于商业友好的 <a href='https://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache-2.0</a> 开源协议<b>免费开源</b>发布我们希望能为业界持续输出正向积极的力量不仅做开源的受益者也能成为开源贡献者与开源社区一起共建共享开源生态
</>
),
},
{
title: '成熟架构、稳定可靠',
title: '成熟生态、快速开发',
Svg: require('../../static/img/feat_coming.svg').default,
description: (
<>
盘古技术栈融合云原生思想在微服务容器化DevOps 等方面完美支持和适配可在云原生时代构建以服务为中心的现代应用架构帮助用户在云环境中更好的构建交付和管理自己的微服务平台
由盘古服务开发框架」、「中后台系统开发脚手架」、「移动端多平台开发脚手架组成前后台三维多端行业数字化赋能开发框架可在云原生时代构建以服务为中心的现代应用架构帮助用户在云环境中更好的构建和交付数字化开发任务
</>
),
},
......@@ -26,8 +26,8 @@ const FeatureList = [
Svg: require('../../static/img/feat_vault.svg').default,
description: (
<>
聚焦面向移动互联网的电商金融云端 SAAS 服务等大并发高可用可扩展的业务场景
同时也能满足诸如 ERP CRM 等各种企业数字化和各级电子政务系统的中小规模应用需求
聚焦面向移动互联网的电商金融云端 SAAS 服务等大并发高可用可扩展的互联网应用场景
同时也能满足诸如 ERP CRM 等各种企业数字化和各级电子政务系统的中小规模业务需求
</>
),
}
......
---
hide_table_of_contents: false
---
<head>
<title>盘古开发框架 | 致敬 & 鸣谢</title>
<meta name="keywords" content="盘古开发框架 | 常见问答" />
<meta name="description" content="盘古开发框架是一套轻量稳健的工业级分布式微服务开发治理框架(兼容单体分层架构)" />
</head>
# 盘古开发框架常见问答
#### 1. 盘古开发框架的开源协议是啥?创始初衷和目标愿景是什么?
「盘古开发框架」基于商业友好的 [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) 协议**开源**发布,且是**免费**的,创始初衷是「分享经验-传递价值-成就你我」。目标愿景是「共建共享开源生态」,不仅做开源生态的受益者也希望成为开源生态的贡献者。
#### 2. 盘古开发框架可以开发前端吗?有没有现成的『通用权限管理系统』?
可以。盘古前端基于 SUCI 开发。SCUI 是一个中后台前端解决方案,基于 VUE3 和 ElementPlus 实现。更多 SCUI 信息,请直接参考其 [项目主页和相关文档](https://lolicode.gitee.io/scui-doc/guide/)。同时,我们基于 SCUI 和盘古开发框架后端能力提供了一套轻量成熟的 [权限系统参考实现](/online-demo)。大家可以基于此快速进行业务系统的二次开发。
#### 3. 盘古开发框架可以做单体开发吗?
可以。从纯技术角度看,盘古开发的最佳姿势是 [分布式微服务开发](/docs/quick-start/how-to-make-microservice-architecture-app),但也支持搭建 [垂直单体分层架构的开发模式](/docs/quick-start/how-to-make-monomer-architecture-app)
## 下一步
继续阅读其它章节获取你想要的答案或通过我们的 [开发者社区](/community) 寻求更多帮助。
\ No newline at end of file
......@@ -12,12 +12,12 @@ function HomepageHeader() {
<header className={clsx('hero hero--primary', styles.heroBanner)}>
<div className="container">
<h1 className="hero__title"><span className={styles.hero__title2}>盘古开发框架</span></h1>
<p className="hero__subtitle">一套轻量稳健的工业级<b> Web 接口服务</b>和<b>中后台业务系统</b>开发框架</p>
<p className="hero__subtitle">一套轻量稳健的工业级行业数字化赋能开发框架</p>
<div className="btn-group">
<div className={styles.buttons}>
<Link
className={styles.xcbutton}
to="/docs/intro">
to="/intro">
快速开始
</Link>
<Link
......
---
hide_table_of_contents: false
---
<head>
<title>盘古开发框架简介</title>
</head>
export const Highlight = ({children, color}) => (
<span
style={{
backgroundColor: color,
borderRadius: '3px',
color: '#fff',
padding: '0.1rem',
margin: '0.2rem'
}}>
{children}
</span>
);
# 盘古开发框架简介
「盘古开发框架」是一套轻量稳健的工业级前、中、后台三维多端行业数字化赋能开发框架。基于商业友好的 [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) 协议<Highlight color="#25c2a0">免费开源</Highlight>发布。我们希望不仅是开源的受益者也能成为开源贡献者,与开源社区一起**共建共享开源生态**
## 生态子项目
盘古开发框架由「盘古服务开发框架」、「盘古中后台业务系统开发脚手架」、「盘古移动端多平台开发脚手架」三个子项目组成。可以单独拆箱使用,也可以打包整合。
#### 盘古服务开发框架
[盘古服务开发框架](/docs/intro)(PanGu Service Framework)以 Dubbo、Nacos 和 Spring Boot 为核心架构,可在云原生时代构建以「服务」为中心的现代应用架构,帮助用户在云环境中更好的构建、交付和管理自己的微服务平台(也兼容支持垂直单体分层架构开发模式)。
#### 盘古中后台业务系统开发脚手架
[盘古中后台业务系统开发脚手架](/admin/intro)(PanGu Admin)是一套基于 SCUI(Vue3、Element-Plus) + 盘古服务开发框架的中后台业务系统前后端统一解决方案。并预置了轻量成熟的权限系统参考实现,用户可以基于此快速搭建中后台业务系统二次开发脚手架。
#### 盘古移动端多平台开发脚手架
[盘古移动端多平台开发脚手架](/admin/intro)(PanGu App Starter) 是集成了 uni-app 内置组件、官方扩展组件和全面兼容 nvue 的 uni-app 生态框架 uView UI 的多平台快速开发脚手架。用户可以基于此完成Android/IOS App、微信小程序、H5 应用的快速开发(一次开发,针对不同平台编译发布版本)。
## 适用场景
基于盘古开发框架的前、中、后台三维多端行业数字化赋能能力,用户既能快速构建面向(移动)互联网的电商、金融、云端 SAAS 服务等大并发高可用可扩展的互联网应用场景,同时也能满足诸如 ERP 、CRM 等各种企业数字化和各级电子政务系统的中小规模业务需求。
\ No newline at end of file
......@@ -44,3 +44,6 @@ hide_table_of_contents: false
- [Vue.js 3](https://vuejs.org):An approachable, performant and versatile framework for building web user interfaces.
- [Element Plus](https://element-plus.gitee.io/en-US):A Vue 3 based component library for designers and developers.
- [SCUI](https://lolicode.gitee.io/scui-doc):Vue3 + element plus based front-end solutions in the background.
- [uni-app](https://uniapp.dcloud.net.cn/):是一个使用 Vue.js 开发所有前端应用的框架,开发者编写一套代码,可发布到iOS、Android、Web(响应式)、以及各种小程序(微信/支付宝/百度/头条/飞书/QQ/快手/钉钉/淘宝)、快应用等多个平台。
- [uView UI](https://uniapp.dcloud.net.cn/):是全面兼容nvue的uni-app生态框架,全面的组件和便捷的工具会让您信手拈来,如鱼得水。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册