From 725ca7bdd3d24da5650f84d3dba2ff4f9cdac2a4 Mon Sep 17 00:00:00 2001 From: sudoooooo Date: Mon, 3 Jun 2024 16:36:59 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E5=A2=9E=E5=8A=A0=20README=5FEN.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 72 +++++++++++----- README_EN.md | 233 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 282 insertions(+), 23 deletions(-) create mode 100644 README_EN.md diff --git a/README.md b/README.md index 175fc35e..0973f75d 100644 --- a/README.md +++ b/README.md @@ -4,22 +4,25 @@

- commit + commit codecov - issues + issues - commit + commit - pr + pr - docs + docs + + + docs
@@ -28,7 +31,7 @@   **XIAOJUSURVEY**是一套轻量、安全的**问卷系统基座**，提供面向个人和企业的一站式产品级解决方案，快速满足各类线上调研场景。 -  内部系统已沉淀40+种题型，累积精选模板100+，适用于市场调研、客户满意度调研、在线考试、投票、报道、测评等众多场景。数据能力上，经过上亿量级打磨，沉淀了分题统计、交叉分析、多渠道分析等在线报表能力，快速满足专业化分析。 +  内部系统已沉淀 40+种题型，累积精选模板 100+，适用于市场调研、客户满意度调研、在线考试、投票、报道、测评等众多场景。数据能力上，经过上亿量级打磨，沉淀了分题统计、交叉分析、多渠道分析等在线报表能力，快速满足专业化分析。   开源项目以打造**调研基座**为核心，围绕**平台能力**、**工程架构**、**研发体系**进行建设，大家可以「快速」打造「专属」问卷系统：[快速了解生态发展理念](https://xiaojusurvey.didi.cn/docs/next/community/%E7%94%9F%E6%80%81%E5%BB%BA%E8%AE%BE) @@ -42,31 +45,35 @@ - 数据安全：传输加密、脱敏等 -> 更全的建设请查阅 [官方Feature](https://github.com/didi/xiaoju-survey/issues/45) +> 更全的建设请查阅 [官方 Feature](https://github.com/didi/xiaoju-survey/issues/45) _**(个人和企业用户均可快速构建特定领域的调研类解决方案。)**_ # 技术 -Web端：Vue3 + ElementPlus；C端多端渲染（在建，[申请加入共建](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#%E6%88%90%E4%B8%BA%E5%AE%98%E6%96%B9%E4%B8%93%E9%A1%B9%E5%BB%BA%E8%AE%BE%E8%80%85)） -Server端：Nestjs + MongoDB；Java（在建，[申请加入共建](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#%E6%88%90%E4%B8%BA%E5%AE%98%E6%96%B9%E4%B8%93%E9%A1%B9%E5%BB%BA%E8%AE%BE%E8%80%85)） +Web 端：Vue3 + ElementPlus；C 端多端渲染（在建，[申请加入共建](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#%E6%88%90%E4%B8%BA%E5%AE%98%E6%96%B9%E4%B8%93%E9%A1%B9%E5%BB%BA%E8%AE%BE%E8%80%85)） + +Server 端：Nestjs + MongoDB；Java（在建，[申请加入共建](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#%E6%88%90%E4%B8%BA%E5%AE%98%E6%96%B9%E4%B8%93%E9%A1%B9%E5%BB%BA%E8%AE%BE%E8%80%85)） 智能化基座：（在建） # 项目优势 + **一、具备全面的综合性和专业性** - [制定了问卷标准化协议规范](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) +- [制定了问卷 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) 设计语言是系统灵活性、一致性的基石，保障系统支撑的实际业务运转拥有极高的用户体验。包含两部分： + - 设计规范：灵活、降噪、统一 - 交互规范：遵循用户行为特征，遵循产品定位，遵循成熟的用户习惯 @@ -77,13 +84,14 @@ Server端：Nestjs + MongoDB；Java（在建，[申请加入共建](https://xiao - [题型物料化设计，自由定制扩展](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) 围绕问卷生命周期提供了完整的产品化能力，包含用户管理: 登录、注册、问卷权限，问卷管理: 创、编、投、收、数据分析，可快速构建特定领域的调研类解决方案。 @@ -98,14 +106,15 @@ Server端：Nestjs + MongoDB；Java（在建，[申请加入共建](https://xiao - [部署成本低，快速上线](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化方案，提供了完善的部署指导手册。 + 前后端分离，提供 Docker 化方案，提供了完善的部署指导手册。 # 快速启动 -Node版本 >= 18.x， +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 ``` @@ -113,93 +122,110 @@ 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、数据保存在内存中，重启服务会更新数据。
2、启动内存服务器新实例时，如果找不到MongoDB二进制文件会自动下载，因此首次可能需要一些时间。 +> +> 1、数据保存在内存中，重启服务会更新数据。
2、启动内存服务器新实例时，如果找不到 MongoDB 二进制文件会自动下载，因此首次可能需要一些时间。 ### 方案二、(生产推荐) #### 1、启动数据库 -> 项目使用MongoDB：[MongoDB安装指导](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E6%95%B0%E6%8D%AE%E5%BA%93#%E5%AE%89%E8%A3%85) +> 项目使用 MongoDB：[MongoDB 安装指导](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E6%95%B0%E6%8D%AE%E5%BA%93#%E5%AE%89%E8%A3%85) -- 配置数据库，查看[MongoDB配置](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E6%95%B0%E6%8D%AE%E5%BA%93) - -- 启动本地数据库，查看[MongoDB启动](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E6%95%B0%E6%8D%AE%E5%BA%93#%E4%BA%94%E5%90%AF%E5%8A%A8) +- 配置数据库，查看[MongoDB 配置](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E6%95%B0%E6%8D%AE%E5%BA%93) + +- 启动本地数据库，查看[MongoDB 启动](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E6%95%B0%E6%8D%AE%E5%BA%93#%E4%BA%94%E5%90%AF%E5%8A%A8) #### 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)

-## QQ交流群 +## QQ 交流群 + 官方群会发布项目最新消息、建设计划和社区活动，欢迎你的加入： [](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一下 ❤️❤️❤️，你的支持是我们最大的动力。 + +开源不易，如果该项目对你有帮助，请 star 一下 ❤️❤️❤️，你的支持是我们最大的动力。 [![Star History Chart](https://api.star-history.com/svg?repos=didi/xiaoju-survey&type=Date)](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)，你的加入使我们最大的荣幸。 ## Feature -关注每周推出的建设：[官方Feature](https://github.com/didi/xiaoju-survey/issues/45) + +关注每周推出的建设：[官方 Feature](https://github.com/didi/xiaoju-survey/issues/45) ## CHANGELOG + 关注重大变更：[MAJOR CHANGELOG](https://github.com/didi/xiaoju-survey/issues/48) ## 文章分享 diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 00000000..1f48bc49 --- /dev/null +++ b/README_EN.md @@ -0,0 +1,233 @@ +
+

+ +

+
+ + commit + + + codecov + + + issues + + + commit + a + + pr + + + docs + + + docs + +
+
+ +
+ +  XIAOJUSURVEY is a lightweight, secure questionnaire system foundation that provides one-stop product-level solutions for individuals and enterprises, quickly meeting various online survey scenarios. + +  The internal system has accumulated over 40 question types and more than 100 selected templates, suitable for market research, customer satisfaction surveys, online exams, voting, reporting, evaluations, and many other scenarios. In terms of data capabilities, it has been honed through hundreds of millions of iterations, resulting in the ability to provide online reports with per-question statistics, cross-analysis, and multi-channel analysis, quickly meeting professional analysis needs. + +  The open-source project focuses on building a survey foundation, constructing around platform capabilities, engineering structure, and development systems, allowing everyone to 「quickly」 create their own 「exclusive」 questionnaire system: [quickly understanding the ecological development philosophy](https://xiaojusurvey.didi.cn/docs/next/community/%E7%94%9F%E6%80%81%E5%BB%BA%E8%AE%BE). + +# Function Overview + +- Questionnaire Management: Create, edit, distribute, collect, data analysis. + +- Diverse Question Types: Single-line input, multi-line input, single choice, multiple choice, true/false, rating, voting, etc. + +- User Management: Login, registration, permissions management. + +- Data Security: Encrypted transmission, data masking, etc. + +> For more comprehensive features, please refer to the official Feature documentation. + + + +_**(Both individual and enterprise users can quickly build survey solutions specific to their fields.)**_ + +# Technology + +Web: Vue3 + ElementPlus; Multi-end rendering for C-end (under construction, application for co-construction welcome). + +Server: Nestjs + MongoDB; Java (under construction). + +Intelligent Foundation: (under construction). + +# Project Advantages + +**1. Comprehensive and Professional** + +- [Standardized Protocols for Questionnaires](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) + +Ensuring concept interoperability is the foundation and core of the entire system. Based on practical business experience, two main categories have been established: + +Business Descriptions: Questionnaire protocol, question type protocol. + +Material Descriptions: Question type material protocol, including question types and settings. + +- [UI/UX Standardization for Questionnaires](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) + +The design language is the cornerstone of system flexibility and consistency, ensuring the system supports actual business operations with high user experience. It includes: + +Design Standards: Flexible, noise-reducing, unified. + +Interaction Standards: Follows user behavior characteristics, product positioning, and mature user habits. + +- [WYSIWYG with High Consistency in Construction and Rendering](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) + +In practical business usage, the system includes both questionnaire generation and deployment. We design question types in a scenario-based manner to ensure high consistency from production to application. + +- [Materialized Question Type Design for Free Customization and Extension](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) + +The core component of questionnaires is question types, and their configurability determines the extensibility of business scenarios and the system's reusability. Each question type has general capabilities and atomic characteristics, ensuring high customization. + +- [Compliance Accumulation and High Expandability in Security Capabilities](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) + +Data encryption, sensitive information detection, and anti-vote brushing capabilities ensure the security of the questionnaire publishing and data collection process. +Lightweight Design for Quick Integration and Flexible Expansion. + +**2. Product-Level Open-Source Solution for Rapid Survey Process Implementation** + +- [Product-Level Open-Source Solution for Rapid Survey Process Implementation](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) + +Provides complete product capabilities around the questionnaire lifecycle, including user management (login, registration, questionnaire permissions) and questionnaire management (create, edit, distribute, collect, data analysis), allowing for quick construction of survey solutions in specific fields. + +- [Out-of-the-Box Questionnaire Design to Reduce Domain Complexity](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) + +High flexibility in questionnaire composition leads to high complexity in editing capabilities. We divide questionnaire editing into five sub-domains for product capability clustering and guide system modular design and development. Based on module arrangement and management, it can be used out-of-the-box. + +- [Low Cost for Secondary Development and Easy Customization](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) + +The entire system is designed based on protocol standardization, function modularization, and management configuration, and provides a complete set of documentation and development and extension manuals. + +- [Low Deployment Cost for Quick Online Launch](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) + +The front-end and back-end separation, Dockerization solutions, and complete deployment guidance manual. + +# Quick Start + +Node Version >= 18.x, [ check environment preparation guide.](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) + +Clone Project + +```shell +git clone git@github.com:didi/xiaoju-survey.git +``` + +## Server Startup + +### Option 1: Quick Start without Database Installation + +> _This is convenient for quickly previewing the project. For formal projects, use Option 2._ + +#### 1.Install Dependencies + +```shell +cd server +npm install +``` + +#### 2.Start + +```shell +npm run local +``` + +> The service relies on mongodb-memory-server: +> 1.Data is stored in memory and will be updated upon service restart. +> 2.When starting a new instance of the memory server, it will automatically download MongoDB binaries if not found, which might take some time initially. + +### Option 2: (Recommended for Production) + +#### 1.Start Database + +> The project uses MongoDB: [MongoDB Installation Guide](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E6%95%B0%E6%8D%AE%E5%BA%93#%E5%AE%89%E8%A3%85) + +- Configure the database, check MongoDB configuration. +- Start local database, check MongoDB startup. + +#### 2.Install Dependencies + +```shell +cd server +npm install +``` + +#### 2.Install Dependencies + +```shell +npm run dev +``` + +## Frontend Startup + +### Install Dependencies + +```shell +cd web +npm install +``` + +### Start + +```shell +npm run serve +``` + +## Access + +### Questionnaire Management End + +[http://localhost:8080/management](http://localhost:8080) + +### Questionnaire Deployment End + +Create and publish a questionnaire. + +[http://localhost:8080/render/:surveyPath](http://localhost:8080/render/:surveyPath) + +

+ +## QQ Group + +The official group will release the latest project news, construction plans, and community activities. Welcome to join: + +[](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=P61UJI_q8AzizyBLGOm-bUvzNrUnSQq-&authKey=yZFtL9biGB5yiIME3%2Bi%2Bf6XMOdTNiuf0pCIaviEEAIryySNzVy6LJ4xl7uHdEcrM&noverify=0&group_code=920623419) + +## WeChat Group + +The official group will release the latest project news, construction plans, and community activities. Any questions and cooperation can contact the assistant: + + + +## Star + +Open source is not easy. If this project helps you, please star it ❤️❤️❤️. Your support is our greatest motivation. + +## Feedback + +If you use this project, please leave feedback:[I'm using](https://github.com/didi/xiaoju-survey/issues/64), Your support is our greatest. + +## Contribution + +If you want to become a contributor or expand your technical stack, please check: [Contributor Guide](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). Your participation is our greatest honor. + +## Feature + +Pay attention to weekly construction updates: [Official Feature](https://github.com/didi/xiaoju-survey/issues/45) + +## CHANGELOG + +Follow major changes: [MAJOR CHANGELOG](https://github.com/didi/xiaoju-survey/issues/48) + +## Article Sharing + +1、[JueJin](https://juejin.cn/user/3705833332160473/posts)、2、[InfoQ](https://www.infoq.cn/profile/7E08AC616A07B2/publish) + +[Welcome to contribute.](https://xiaojusurvey.didi.cn/docs/next/article/%E7%AE%80%E4%BB%8B)