hypethron/院庭

介绍 Introduction

"hypethron/院庭"是一款基于React和Node.js的信息可视化、统计和管理系统。

整体将采用 React+Node.js(koa) 前后端分离的开发模式，数据库采用Redis+MySQL，系统功能将包含以下内容：

• 管理员后台系统
• 基本信息采集系统
• 基本信息可视化统计(Echarts实现)
• 基本信息管理
• 高级过滤搜索
• 数据库导出、备份
• 多级权限控制
• 群发邮件通知
• 服务器日志
• 黑名单ip过滤/DDOS防范

一些Feature:

• 支持Https和Http及多端口访问
• SQL注入防范
• XSS攻击防范
• RESTful
• 数据压缩传送
• JWT访问控制
• 二次开发所需的文档
• 持续集成测试
• SPA(PWA for Https)
• Cookie签名认证
• Session加密(AES)
• 前端可跨平台开发
• ...

你可以到此处查看该项目的效果：项目演示|Examples ；或在此查看版本信息及开发进度：

快速上手 Quick-Start

Ⅰ 基础环境 Runtime

“hypethron/院庭”依赖于Node.js环境，所以您应当先在本机配置Node.js环境。

您可以通过指令node -v查看你的系统是否已经安装Node.js环境及其版本号。我们推荐的Node版本为10.8.x以上。

否则，您应该按照这篇文章的指引安装或重新安装相应版本的Node.js环境。

Ⅱ 安装应用 Installation

目前提供了以下几种方式来获取Web应用：

① 从Github安装(Install with Git)

• Step 1 获取源码 Download Source-Code

git clone git@github.com:WhiteRobe/hypethron.git

• Step 2 配置环境 Initialization

(Windows) 执行 /InitEnvironment(windows).bat 脚本，从淘宝镜像源拉取项目依赖。

(Linux) 执行 /InitEnvironment(linux).sh 脚本，从淘宝镜像源拉取项目依赖。

② 直接使用发行版(Install with release-version)

(暂未取得发行版)

Ⅲ 服务器配置 Configuration

服务器需要连接MySQL、Redis数据库及SMTP服务器，在已经安装相应软件的基础下，这可能需要花费3~5分钟。

您可以参考配置文档进行这些常量值的配置。

Ⅳ 启动项目 Usage

1. (第一次启动时)执行npm run build打包、发布SPA应用到/build目录下。
2. 在完备的Node.js开发环境下，进入项目根目录，通过 npm run server-start 指令启动服务器。

程序将自动创建超级管理员账号，你可以使用超管的权限，利用相关API修改绑定的邮箱：

字段	预设值
username/账户名	SuperAdmin
password/密码	admin123

项目演示 Example

完整界面演示请参考：[暂未编写]

项目文档 Documents

我们将提供开发过程中的各类文档，请查看我们的Wiki。另外，到此查看项目依赖。

社区指南 Contributing

您可以在遵循本项目相关开源协议的情况下，使用、修改本项目。

在参与项目时请遵循行为指南。

我们欢迎任何人指出缺点、修正我们的项目：

1. 请【Fork】这个项目，修改、添加您觉得有必要变动的内容，向我们提交【Pull Request】。
2. 在【Issues】中提出您的意见。

For more detail? @See CONTRIBUTING.md。

作者 Collaborators

WhiteRobe(@WhiteRobe)
JiaWeiWangWang(@jiaweiwangwang)