236 lines
9.7 KiB
Markdown
236 lines
9.7 KiB
Markdown
<div align=center>
|
||
<p>
|
||
<img src="https://img-hxy021.didistatic.com/static/starimg/img/j8lBA6yy201698840712358.jpg" width="300" align='center' />
|
||
</p>
|
||
<div>
|
||
<a href="https://github.com/didi/xiaoju-survey/graphs/contributors">
|
||
<img src="https://img.shields.io/badge/node-%3E=18-green" alt="commit">
|
||
</a>
|
||
<a href="https://app.codecov.io/github/didi/xiaoju-survey">
|
||
<img src="https://img.shields.io/codecov/c/github/didi/xiaoju-survey" alt="codecov">
|
||
</a>
|
||
<a href="https://github.com/didi/xiaoju-survey/issues">
|
||
<img src="https://img.shields.io/github/issues/didi/xiaoju-survey" alt="issues">
|
||
</a>
|
||
<a href="https://github.com/didi/xiaoju-survey/graphs/contributors">
|
||
<img src="https://img.shields.io/github/last-commit/didi/xiaoju-survey?color=red" alt="commit">
|
||
</a>
|
||
<a href="https://github.com/didi/xiaoju-survey/pulls">
|
||
<img src="https://img.shields.io/badge/PRs-welcome-%23ffa600" alt="pr">
|
||
</a>
|
||
<a href="https://xiaojusurvey.didi.cn">
|
||
<img src="https://img.shields.io/badge/help-%E5%AE%98%E7%BD%91-blue" alt="docs">
|
||
</a>
|
||
<a href="https://github.com/didi/xiaoju-survey/blob/main/README_EN.md">
|
||
<img src="https://img.shields.io/badge/help-README_EN-50c62a" alt="docs">
|
||
</a>
|
||
</div>
|
||
</div>
|
||
|
||
<br />
|
||
|
||
  **XIAOJUSURVEY**是一套轻量、安全的**问卷系统基座**，提供面向个人和企业的一站式产品级解决方案，快速满足各类线上调研场景。
|
||
|
||
  内部系统已沉淀 40+种题型，累积精选模板 100+，适用于市场调研、客户满意度调研、在线考试、投票、报道、测评等众多场景。数据能力上，经过上亿量级打磨，沉淀了分题统计、交叉分析、多渠道分析等在线报表能力，快速满足专业化分析。
|
||
|
||
  开源项目以打造**调研基座**为核心，围绕**平台能力**、**工程架构**、**研发体系**进行建设，大家可以「快速」打造「专属」问卷系统：[快速了解生态发展理念](https://xiaojusurvey.didi.cn/docs/next/community/%E7%94%9F%E6%80%81%E5%BB%BA%E8%AE%BE)
|
||
|
||
# 功能简介
|
||
|
||
- 问卷管理：创、编、投、收、数据分析
|
||
|
||
- 多样化题型：单行输入框、多行输入框、单项选择、多项选择、判断题、评分、投票、...
|
||
|
||
- 用户管理：登录、注册、权限管理
|
||
|
||
- 数据安全：传输加密、脱敏等
|
||
|
||
> 更全的建设请查阅 [官方 Feature](https://github.com/didi/xiaoju-survey/issues/45)
|
||
|
||
<img src="https://github.com/didi/xiaoju-survey/assets/16012672/dd427471-368d-49d9-bc44-13c34d84e3be" width="700" />
|
||
|
||
_**(个人和企业用户均可快速构建特定领域的调研类解决方案。)**_
|
||
|
||
# 技术
|
||
|
||
Web 端：Vue3 + ElementPlus；C 端多端渲染（规划中）
|
||
|
||
Server 端：Nestjs + MongoDB；Java（在建，[欢迎加入共建](https://github.com/didi/xiaoju-survey/issues/306)）
|
||
|
||
智能化基座：（规划中）
|
||
|
||
# 项目优势
|
||
|
||
**一、具备全面的综合性和专业性**
|
||
|
||
- [制定了问卷标准化协议规范](https://xiaojusurvey.didi.cn/docs/next/agreement/%E3%80%8A%E9%97%AE%E5%8D%B7Meta%E5%8D%8F%E8%AE%AE%E3%80%8B)
|
||
|
||
领域标准保障概念互通，是全系统的基础和核心。基于实际业务经验，沉淀了两大类：
|
||
|
||
- 业务描述：问卷协议、题型协议
|
||
- 物料描述：题型物料协议，包含题型和设置器
|
||
|
||
- [制定了问卷 UI/UX 规范](https://xiaojusurvey.didi.cn/docs/next/design/%E3%80%8A%E8%AE%BE%E8%AE%A1%E8%A7%84%E8%8C%83%E3%80%8B)
|
||
|
||
设计语言是系统灵活性、一致性的基石，保障系统支撑的实际业务运转拥有极高的用户体验。包含两部分：
|
||
|
||
- 设计规范：灵活、降噪、统一
|
||
- 交互规范：遵循用户行为特征，遵循产品定位，遵循成熟的用户习惯
|
||
|
||
- [所见即所得，搭建渲染一致性高](https://xiaojusurvey.didi.cn/docs/next/document/%E8%AE%BE%E8%AE%A1%E5%8E%9F%E7%90%86/%E9%A2%98%E5%9E%8B%E5%9C%BA%E6%99%AF%E5%8C%96%E8%AE%BE%E8%AE%A1)
|
||
|
||
实际业务使用上包含问卷生成和投放使用，即对于系统的搭建端和渲染端。我们将题型场景化设计，以满足一份问卷从加工生产到投放应用的高度一致。
|
||
|
||
- [题型物料化设计，自由定制扩展](https://xiaojusurvey.didi.cn/docs/next/document/%E8%AE%BE%E8%AE%A1%E5%8E%9F%E7%90%86/%E9%A2%98%E5%9E%8B%E7%89%A9%E6%96%99%E5%8C%96%E8%AE%BE%E8%AE%A1/%E5%9F%BA%E7%A1%80%E8%AE%BE%E8%AE%A1)
|
||
|
||
题型是问卷最核心的组成部分，而题型可配置化能力决定了上层业务可扩展的场景以及系统自身可复用的场景。
|
||
题型架构设计上，主打每一类题型拥有通用基础能力，每一种题型拥有原子化特性能力，并保障高度定制化。
|
||
|
||
- [合规建设沉淀积累，安全能力拓展性高](https://xiaojusurvey.didi.cn/docs/next/document/%E5%AE%89%E5%85%A8%E8%AE%BE%E8%AE%A1/%E6%A6%82%E8%BF%B0)
|
||
|
||
数据加密传输、敏感信息精细化检测、投票防刷等能力，保障问卷发布、数据回收链路安全性。
|
||
|
||
**二、轻量化设计，快速接入、灵活扩展**
|
||
|
||
- [产品级开源方案，快速产出一套调研流程](https://xiaojusurvey.didi.cn/docs/next/document/%E4%BA%A7%E5%93%81%E6%89%8B%E5%86%8C/%E6%A6%82%E8%BF%B0)
|
||
|
||
围绕问卷生命周期提供了完整的产品化能力，包含用户管理: 登录、注册、问卷权限，问卷管理: 创、编、投、收、数据分析，可快速构建特定领域的调研类解决方案。
|
||
|
||
- [问卷设计开箱即用，降低领域复杂度](https://xiaojusurvey.didi.cn/docs/next/document/%E8%AE%BE%E8%AE%A1%E5%8E%9F%E7%90%86/%E9%97%AE%E5%8D%B7%E6%90%AD%E5%BB%BA%E9%A2%86%E5%9F%9F%E5%8C%96%E8%AE%BE%E8%AE%A1)
|
||
|
||
问卷组成具有高灵活性，此业务特征带来问卷编辑能力的高复杂性设计。我们将问卷编辑划分为五大子领域，进行产品能力聚类，同时指导系统模块化设计和开发。基于模块编排和管理，能够开箱即用。
|
||
|
||
- [二次开发成本低，轻松定制专属调研系统](https://xiaojusurvey.didi.cn/docs/next/document/%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C/%E5%B7%A5%E7%A8%8B%E9%85%8D%E7%BD%AE%E5%8C%96)
|
||
|
||
全系统设计原则基于协议标准化、功能模块化、管理配置化，并提供了一些列完整的文档和开发及扩展手册。
|
||
|
||
- [部署成本低，快速上线](https://xiaojusurvey.didi.cn/docs/next/document/%E5%B7%A5%E7%A8%8B%E9%83%A8%E7%BD%B2/Docker%E9%83%A8%E7%BD%B2)
|
||
|
||
前后端分离，提供 Docker 化方案，提供了完善的部署指导手册。
|
||
|
||
# 快速启动
|
||
|
||
Node 版本 >= 18.x，
|
||
[查看环境准备指导](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B)
|
||
|
||
复制工程
|
||
|
||
```shell
|
||
git clone git@github.com:didi/xiaoju-survey.git
|
||
```
|
||
|
||
## 服务端启动
|
||
|
||
### 方案一、快速启动，无需安装数据库
|
||
|
||
> _便于快速预览工程，对于正式项目需要使用方案二。_
|
||
|
||
#### 1、安装依赖
|
||
|
||
```shell
|
||
cd server
|
||
npm install
|
||
```
|
||
|
||
#### 2、启动
|
||
|
||
```shell
|
||
npm run local
|
||
```
|
||
|
||
> 服务运行依赖 [mongodb-memory-server](https://github.com/nodkz/mongodb-memory-server)：
|
||
>
|
||
> 1、数据保存在内存中，重启服务会更新数据。<br />2、启动内存服务器新实例时，如果找不到 MongoDB 二进制文件会自动下载，因此首次可能需要一些时间。
|
||
|
||
### 方案二、(生产推荐)
|
||
|
||
#### 1、配置数据库
|
||
|
||
> 项目使用 MongoDB，需要提前准备，请查看[如何拥有 MongoDB 指南](./数据库#安装)
|
||
|
||
配置数据库信息，查看[MongoDB 配置](./数据库)。
|
||
|
||
#### 2、安装依赖
|
||
|
||
```shell
|
||
cd server
|
||
npm install
|
||
```
|
||
|
||
#### 3、启动
|
||
|
||
```shell
|
||
npm run dev
|
||
```
|
||
|
||
## 前端启动
|
||
|
||
### 安装依赖
|
||
|
||
```shell
|
||
cd web
|
||
npm install
|
||
```
|
||
|
||
### 启动
|
||
|
||
```shell
|
||
npm run serve
|
||
```
|
||
|
||
## 访问
|
||
|
||
### 问卷管理端
|
||
|
||
[http://localhost:8080/management](http://localhost:8080)
|
||
|
||
### 问卷投放端
|
||
|
||
创建并发布问卷。
|
||
|
||
[http://localhost:8080/render/:surveyPath](http://localhost:8080/render/:surveyPath)
|
||
|
||
<br /><br />
|
||
|
||
## 微信交流群（推荐）
|
||
|
||
官方群会发布项目最新消息、建设计划和社区活动，欢迎你的加入。任何问题和合作可以联系小助手：
|
||
|
||
<img src="https://img-hxy021.didistatic.com/static/starimg/img/KXKvc7sjHz1700061188156.png" width="200" />
|
||
|
||
## QQ 交流群
|
||
|
||
官方群会发布项目最新消息、建设计划和社区活动，欢迎你的加入：
|
||
|
||
[<img src="https://img-hxy021.didistatic.com/static/starimg/img/iJUmLIHKV21700192846057.png" width="210" />](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=P61UJI_q8AzizyBLGOm-bUvzNrUnSQq-&authKey=yZFtL9biGB5yiIME3%2Bi%2Bf6XMOdTNiuf0pCIaviEEAIryySNzVy6LJ4xl7uHdEcrM&noverify=0&group_code=920623419)
|
||
|
||
## Star
|
||
|
||
开源不易，如果该项目对你有帮助，请 star 一下 ❤️❤️❤️，你的支持是我们最大的动力。
|
||
|
||
[](https://star-history.com/#didi/xiaoju-survey&Date)
|
||
|
||
## 记录
|
||
|
||
如果你使用了该项目，请记录反馈：[我在使用](https://github.com/didi/xiaoju-survey/issues/64)，你的支持是我们最大的动力。
|
||
|
||
## 贡献
|
||
|
||
如果你想成为贡献者或者扩展技术栈，请查看：[贡献者指南](https://xiaojusurvey.didi.cn/docs/next/share/%E5%A6%82%E4%BD%95%E5%8F%82%E4%B8%8E%E8%B4%A1%E7%8C%AE)，你的加入使我们最大的荣幸。
|
||
|
||
## Future Tasks
|
||
|
||
1、[官方 Feature](https://github.com/didi/xiaoju-survey/issues/45)
|
||
|
||
2、[WIP](https://github.com/didi/xiaoju-survey/labels/WIP)
|
||
|
||
## CHANGELOG
|
||
|
||
关注重大变更：[MAJOR CHANGELOG](https://github.com/didi/xiaoju-survey/issues/48)
|
||
|
||
## 文章分享
|
||
|
||
1、[掘金](https://juejin.cn/user/3705833332160473/posts)、2、[CSDN](https://blog.csdn.net/XIAOJUSURVEY)、3、[InfoQ](https://www.infoq.cn/profile/7E08AC616A07B2/publish)、4、[知乎](https://www.zhihu.com/people/xiaojusurvey)
|
||
|
||
[欢迎共建](https://github.com/didi/xiaoju-survey/issues/85)
|