XIAOJUSURVEY Documentation

XIAOJUSURVEY is a lightweight and secure survey system providing a one-stop product-level solution for individuals and enterprises. It is used to build various questionnaires, exams, assessments, and complex forms.

Key capabilities include:

• Data Collection: Supports text input, data selection, ratings, voting, file uploads, etc.
• Smart Logic: Dynamic form design using display logic, jump logic, option/question referencing.
• Permission Management: Space management and multi-role permission control.
• Data Analysis: Online analysis and export, including question-based statistics and cross-analysis.
• AI Integration: AI-generated questionnaires via LLM conversational interfaces.
• Customization: Theme customization (colors, backgrounds, logos) and multi-terminal SDK support.

To run the project locally, you need to start both the server and the web client. Ensure you have Node.js >= 18 installed.

1. Start the Server: Navigate to the server directory, install dependencies, and run the local command.
2. Start the Web Client: Navigate to the web directory, install dependencies, and run the serve command.

Access Points:

• Management (B-end): http://localhost:8080/management
• Rendering (C-end): http://localhost:8080/render/:surveyPath

# 服务启动
cd server
npm install
npm run local

# 页面启动
cd web
npm install
npm run serve

XIAOJUSURVEY supports Docker-based deployment. You can choose between two image versions in your docker-compose.yaml file:

• slim version (xiaojusurvey/xiaoju-survey:latest-slim): Based on node:18-slim. Smaller footprint, contains minimal dependencies, recommended for production environments.
• full version (xiaojusurvey/xiaoju-survey:latest-full): Based on node:18. Includes full development tools like curl, vim, and git, recommended for development or debugging.

Use SERVER_LOCAL_CONFIG to configure file uploads and storage directly on the local server (e.g., via Nginx).

Key configuration options:

• LOCAL_STATIC_RENDER_TYPE: Set to 'server' for Nginx-based local static rendering.
• IS_PRIVATE_READ: Boolean indicating if files require private access.
• FILE_KEY_PREFIX: The storage path prefix (e.g., 'userUpload').
• NEED_AUTH: Boolean indicating if authentication is required for uploads.

const SERVER_LOCAL_CONFIG = {
  LOCAL_STATIC_RENDER_TYPE: 'server', // nginx
  IS_PRIVATE_READ: false,
  FILE_KEY_PREFIX: 'userUpload', // 存储路径
  NEED_AUTH: true,
};

The questionChartsConfig object maps question types (retrieved from menuItems) to the allowed chart types used in the analysis interface. This ensures that specific question types (like NPS or checkboxes) display the appropriate visualizations (e.g., gauge, pie, or bar charts).

export const questionChartsConfig = {
  [menuItems['checkbox']['type']]: ['bar'],
  [menuItems['radio-nps']['type']]: ['gauge', 'pie', 'bar'],
  default: ['pie', 'bar']
}

Use MINIO_CONFIG to configure file uploads to a Minio instance.

Key configuration options:

• FILE_STORAGE_PROVIDER: Must be set to 'minio'.
• FILE_KEY_PREFIX: The prefix for file keys (e.g., 'userUpload/{surveyPath}').
• LINK_EXPIRY_TIME: Duration for which the file link is valid (e.g., '2h').
• ACCESS_KEY, SECRET_KEY, BUCKET, REGION, ENDPOINT: Minio credentials and endpoint.
• USE_SSL: Boolean to enable SSL.

export const MINIO_CONFIG = {
  FILE_STORAGE_PROVIDER: 'minio',
  IS_PRIVATE_READ: false,
  FILE_KEY_PREFIX: 'userUpload/{surveyPath}',
  NEED_AUTH: true,
  LINK_EXPIRY_TIME: '2h',
  ACCESS_KEY: '',
  SECRET_KEY: '',
  BUCKET: '',
  REGION: '',
  ENDPOINT: '',
  USE_SSL: true,
};

Use QINIU_CONFIG to configure file uploads to Qiniu cloud storage.

Key configuration options:

• FILE_STORAGE_PROVIDER: Must be set to 'qiniu'.
• FILE_KEY_PREFIX: The prefix for file keys. Note that {surveyPath} is used as a placeholder for validation (e.g., 'userUpload/{surveyPath}').
• LINK_EXPIRY_TIME: Duration for which the file link is valid (e.g., '2h').
• ACCESS_KEY, SECRET_KEY, BUCKET, ENDPOINT: Cloud provider credentials and endpoint.
• USE_SSL: Boolean to enable SSL.

const QINIU_CONFIG = {
  FILE_STORAGE_PROVIDER: 'qiniu',
  IS_PRIVATE_READ: false,
  FILE_KEY_PREFIX: 'userUpload/{surveyPath}',
  NEED_AUTH: true,
  LINK_EXPIRY_TIME: '2h',
  ACCESS_KEY: '',
  SECRET_KEY: '',
  BUCKET: '',
  ENDPOINT: '',
  USE_SSL: false,
};

Use ALI_OSS_CONFIG to configure file uploads to Alibaba Cloud OSS.

Key configuration options:

• FILE_STORAGE_PROVIDER: Must be set to 'ali-oss'.
• FILE_KEY_PREFIX: The prefix for file keys (e.g., 'userUpload/{surveyPath}').
• LINK_EXPIRY_TIME: Duration for which the file link is valid (e.g., '2h').
• ACCESS_KEY, SECRET_KEY, BUCKET, REGION, ENDPOINT: Alibaba Cloud credentials and region settings.
• USE_SSL: Boolean to enable SSL.

const ALI_OSS_CONFIG = {
  FILE_STORAGE_PROVIDER: 'ali-oss',
  IS_PRIVATE_READ: false,
  FILE_KEY_PREFIX: 'userUpload/{surveyPath}',
  NEED_AUTH: true,
  LINK_EXPIRY_TIME: '2h',
  ACCESS_KEY: '',
  SECRET_KEY: '',
  BUCKET: '',
  REGION: '',
  ENDPOINT: '',
  USE_SSL: false,
};

The analysis module supports two primary types of views defined in analysisTypeMap: dataTable (数据列表) and separateStatistics (分题统计).

When using list-based views, the separateItemListHead defines the standard columns for itemized data:

• text: The option label.
• count: The quantity.
• percent: The percentage/proportion.

The summaryItemConfig allows defining specific score ranges for NPS (Net Promoter Score) analysis. For the radio-nps type, you can define segments like 'Promoters' (推荐者), 'Passives' (中立者), and 'Detractors' (贬损者) using a between summary type and specifying min and max score boundaries.

export const summaryItemConfig = {
  'radio-nps': [
    {
      text: '推荐者',
      field: 'id',
      type: 'between',
      max: 10,
      min: 9
    },
    {
      text: '中立者',
      field: 'id',
      type: 'between',
      max: 8,
      min: 7
    },
    {
      text: '贬损者',
      field: 'id',
      type: 'between',
      max: 6,
      min: 0
    }
  ]
}