From 5cace6e408ed8c4e915ab1769803fb0d3ee4182b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=AE=98=E6=96=B9=E5=94=AE=E5=90=8E?= <1412681764@qq.com>
Date: Fri, 14 Apr 2023 03:47:56 +0000
Subject: [PATCH] add README.md.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: 官方售后 <1412681764@qq.com>
---
README.md | 168 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 168 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..59f9f07b2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,168 @@
+# 一款快速开发SAAS通用管理系统后台框架
+
+
+
+### niucloud-admin是什么？
+niucloud-admin是一款快速开发通用管理后台框架，前端采用最新的技术栈Vite+TypeScript+Vue3+ElementPlus最流行技术架构，后台结合PHP8、Java SDK、Python等主流后端语言搭建，内置集成用户权限、代码生成器、表单设计、云存储、短信发送、素材中心、微信及公众号、Api模块一系列开箱即用功能，是一款快速可以开发企业级应用的软件系统。
+
+### niucloud-admin采用的技术亮点
+
+- 后台php采用thinkphp6+php8+mysql,支持composer快速安装扩展，支持redis缓存以及消息队列，支持多语言设计开发，同时开发采用严格的restful的api设计开发。
+
+- 后台前后端分离采用element-plus、vue3.0、typescript、vite、pina等前端技术,同时使用i18n支持国际化多语言开发。
+
+- 手机端采用uniapp前后端分离，同时使用uview、vue3.0、typescript、vite、pina等前端技术，同时使用i18n支持国际化多语言开发，可以灵活编译成h5,微信小程序，支付宝小程序，抖音小程序等使用场景。
+
+- niucloud-admin采用多租户的saas系统设计，能够提供企业级软件服务运营 ，同时满足用户多站点，多商户，多门店等系统开发需求。
+
+- niucloud-admin结合当前市面上很多框架结构不规范，导致基础结构不稳定等情况，严格定义了分层设计的开发规范，同时api接口严格采用restful的开发规范，能够满足大型业务系统或者微服务的开发需求。
+
+- niucloud-admin前端以及后端采用严格的多语言开发规范，包括前端展示，api接口返回，数据验证，错误返回等全部使用多语言设计规范，使开发者能够真生意义上实现多语言的开发需求。
+
+- niucloud-admin已经搭建好常规系统的开发底层，具体的底层功能包括：管理员管理，权限管理，网站设置，计划任务管理，素材管理，会员管理，会员账户管理，微信公众号以及小程序管理，支付管理，第三方登录管理，消息管理，短信管理，文章管理，前端装修等全面的基础功能，这样开发者不需要开发基础的结构而专心开发业务。
+
+- niucloud-admin系统内置支持微信/支付宝支付，微信公众号/小程序/短信消息管理，阿里云/腾讯云短信，七牛云/阿里云存储等基础的功能扩展，后续会根据实际业务不断扩展基础组件。
+
+- niucloud-admin结合系统结构特点专门开发了代码生成器，这样开发者根据数据表就可以一键生成基础的业务代码，包括：后台php业务代码以及对应的前端vue代码。
+
+- 前端采用标准的element-plus，开发者不需要详细了解前端，只需要用标准的element组件就可以。
+
+- 手机端设计开发了自定义装修，同时提供了基础的开发组件，方便开发者设计开发手机自定义页面装修的开发需求。
+
+- 手机端使用uniapp ，同时使用uview页面展示，可以开发出丰富的手机样式，同时不需要专门学习小程序，app等开发语言，只需要通过uniapp编译就可以。
+
+### 操作指南
+ :fa-th-list: [官网地址](https://www.niucloud.com)
+ | [服务市场]()
+ | [系统功能]()
+ | [系统演示](http://niushopvite.niuteam.cn/)
+ | [使用手册](https://www.kancloud.cn/niucloud/niushop_b2c_v4/1842076)
+ | [二开手册]()
+ | [论坛地址](https://www.niushop.com/web/community/index.html)
+ | [留言评论](https://www.niushop.com/web/community/index.html)
+
+### 演示地址
+- 站点后台演示网址：[ 查看 ]
+https://demo.niucloud.com/admin/ 账号：test 密码：123456
+- 平台后台演示网址：[ 查看 ]
+https://demo.niucloud.com/admin/ 账号：admin 密码：123456
+
+- 前端演示二维码
+
+
+
+### 安装部署
+#### 宝塔部署
+- 1.环境要求
+php 8.0
mysql5.6及以上
启用redis
Nignx/Apache
+- 2.登录网站【https://gitee.com/niuteam/niucloud-admin/】下载框架源码。
+- 3.源码放置到宝塔根目录，访问本地或者虚拟域名，进入安装界面，点击下一步，输入数据库安装信息，下一步完成安装。详细教程查看 :arrow_right: 【开发手册】 :arrow_left:
+- 4.配置伪静态
+可直接复制下方代码：
+Nginx配置
+
+```html
+location / {
+ if (!-e $request_filename) {
+ rewrite ^(.*)$ /index.php/$1 last;
+ break;
+ }
+}
+```
+
+apache配置
+```
+
+Options +FollowSymlinks -Multiviews
+ RewriteEngine On
+ RewriteCond %{REQUEST_FILENAME} !-d
+ RewriteCond %{REQUEST_FILENAME} !-f
+ RewriteRule ^(.*)$ index.php?/$1 [QSA,PT,L]
+ RewriteEngine on RewriteCond % !^$
+
+```
+粘贴位置如下图：
+
+
+#### docker快速部署
+- 1.启动docker，打开终端输入命令行，回车执行命令。
+
+```
+docker run -d --name niucloudadmin_php -p 20221:80 niucloud/niucloudadmin_php:1.6.0
+```
+- 2.访问配置的虚拟域名或者localhost或者127.0.0.1即可进入安装界面。
+
+#### 前端运行
+- 1.拉取代码
+
+```
+git clone https://gitee.com/niuteam/niucloud-admin.git
+```
+- 2.安装依赖
+
+```
+cd niuclooud-admin template
+npm install
+```
+
+- 3.本地运行
+
+```
+npm run dev
+```
+
+- 4.前端代码打包
+
+```
+npm run build
+```
+
+
+**即日起加入Niucloud开发者联盟，不仅可以拿到0~9.9元现金红包，而且还可享受超值六大权益，这还不够，联盟会还会不定时为大家提供免费培训会、答疑会、线上交流会等，在这里您不仅可以快速提升自身研发水平，还可以结识来自五湖四海有共同兴趣爱好的朋友们，还犹豫什么？赶快加入吧~~闭眼上船，一起让我们在Niucloud的陪伴下领略一份精彩非凡的旅行！！！**
+
+### 如何加入Niucloud开发者联盟以及可享受到的六大权益
+
+
+首先来添加属于你的专属客服吧~
+
+
+
+#### 扫描下方二维码加入niucloud-admin开发者交流群
+
+
+### 框架管理端部分页面展示
+
+- 管理端控制台页面，可直观体现站点会员数量、平台拥有的站点数、所有访客数量统计；同时也加入了统计走势图，便于平台根据需求制定或者调整运营策略；主要快捷入口可方便快速打开需要处理的业务数据
+
+- 系统性设置，可助力平台更好的运营
+
+
+
+- 文章模块管理页面展示
+
+- 可自动生成代码
+
+- 素材管理
+
+
+### 开源使用须知
+
+1.允许用于个人学习、毕业设计、教学案例、公益事业、商业使用;
+
+2.本框架应用源代码所有权和著作权归niucloud官方所有，基于niucloud-admin框架开发的应用，所有权和著作权归应用开发商所有。但必须声明是基于niucloud-admin框架开发，请自觉遵守，否则产生的一切任何后果责任由侵权者自负;
+
+3.本框架源码全部开源;包括前端，后端，无任何加密;
+
+4.商用请仔细审查代码和漏洞，不得用于任一国家许可范围之外的商业应用，产生的一切任何后果责任自负;
+
+5.一切事物有个人喜好的标准，本开源代码意在分享，不喜勿喷。
+
+### 战略合作伙伴
+
+
+### 版权信息
+版权所有Copyright © 2023-2030 niucloud-admin 版权所有
+
+All rights reserved。
+
+杭州数字云动科技有限公司 提供技术支持
\ No newline at end of file