formulosity

配方是一个自托管应用程序，用于使用代码而不是传统的调查构建者来构建和部署调查。

这种方法提供了许多优势，包括：

• 版本控制：调查文件可以存储在GitHub存储库中，这使跟踪更改并与他人进行协作变得容易。
• 可重复性：可以轻松共享和复制调查文件，从而轻松重复使用调查或创建现有调查的变化。
• 自动化：调查文件可用于自动化调查的创建和部署，这可以节省时间和精力。

配方使用人类可读的声明语言yaml。

特征

• 管理API
• 调查UI：最终用户（受访者）
• 控制台UI：管理调查
• YAML调查配置
• 基本问题类型
• 默认主题
• 自定义主题支持
• 个性化选项：介绍，Outro等。
• cookie/ip重复响应保护
• 管理用户身份验证
• 不同的数据库选项：SQLite和Postgres
• 继续您离开的地方
• 高级验证规则
• 实时检测调查变化
• UI或通过API的导出响应
• 高级问题类型
• 将答案输入以下问题

在行动中看到它！

管理面板

注意：使用user / pass登录到控制台UI。

调查结构

SURVEYS_DIR中的每个目录都是一项调查。您可以通过设置不同的SURVEYS_DIR ENV VAR配置调查源。

surveys/
├── survey1/
│   ├── metadata.yaml
│   ├── questions.yaml
│   ├── security.yaml
│   ├── variables.yaml
│   └── ...
└── survey2/
    ├── metadata.yaml
    ├── questions.yaml
    └── ...

首先，请查看带有多个示例的./surveys文件夹。

调查文件

元数据

此文件是必需的！该文件由一个YAML对象组成，具有描述调查的特定属性。

• 标题：这是调查开始时向用户显示的主要标题。
• 主题：这指定了应用于调查的视觉主题。当前支持的主题为：默认值。
• 介绍：该文本在第一个问题之前作为介绍出现。
• OUTRO ：该文本是最后一个问题之后的结论。

 title : Survey Title
theme : default # or custom
intro : |
  This is the introduction to the survey.
  It can be multiple lines long.
outro : |
  Thank you for taking the survey.
  Your feedback is important to us.

问题

此文件是必需的！该文件由一个问题列表组成，每个列表定义为具有特定属性的YAML对象。

• 类型：这指定了要问的问题的类型。
• ID ：这为问题提供了唯一的标识符。它对于在分支逻辑或数据分析中引用特定问题很有用。 ID在调查中的所有问题中都必须是唯一的。
• 标签：这是作为问题本身显示给用户的文本。
• 描述：这为用户提供了有关问题的其他信息，例如澄清或说明。
• 选项：此列表定义了single-choice ， multiple-choice和ranking问题类型的可用答案选择。
• fromvariable ：此属性引用一个在单独的变量中定义的变量。yaml文件。该变量应包含用于该问题的选项列表。这允许对期权列表的可重复使用和集中管理。
• 验证：此属性用于为特定问题类型定义验证规则。

 questions :
  - type : single-choice
    id : question1 # optional ID, must be unique across all questions
    label : What is the capital of Germany?
    description : You can select multiple options
    optionsFromVariable : german-city-options # defined in variables.yaml
    options :
      - Berlin
      - Munich
      - Paris
      - London
      - Hamburg
      - Cologne
    validation :
      min : 1
      max : 3

security.yaml

该文件是可选的。该文件由具有调查安全设置的特定属性的YAML对象组成。

• 重复保护：此属性定义了平台如何处理同一用户的重复响应。

 duplicateProtection : cookie # cookie | ip

变量

该文件是可选的。该文件由变量列表组成，每个变量列表定义为具有特定属性的YAML对象。

• ID ：此唯一的标识符引用问题中的变量。在文件中定义的所有变量中，ID必须是唯一的。
• 类型：这指定了存储在变量中的数据类型。当前支持的类型为：列表。

 variables :
  - id : german-city-options # must be unique
    type : list
    options :
      - Berlin
      - Munich
      - Hamburg
      - Cologne 

问题类型

短文

提示用户提供简短的书面答案。

- type : short-text
  label : What is the capital of Germany?
  # set min/max characters
  validation :
    min : 10
    max : 100

长文字

提示用户获取详细的书面答案。

- type : long-text
  label : What is the capital of Germany?
  # set min/max characters
  validation :
    min : 10
    max : 100

单一选择

提出一个问题，只有一个正确的答案从选项列表中提出。

- type : single-choice
  label : What is the capital of Germany?
  options :
    - Berlin
    - Munich
    - Paris
    - London
    - Hamburg
    - Cologne

多项选择

提出一个问题，用户可以在其中选择多个答案（具有限制）。您可以在验证部分中自定义最小和最大允许的选择。

- type : multiple-choice
  label : Which of the following are cities in Germany?
  description : You can select multiple options
  validation :
    min : 1
    max : 3
  options :
    - Berlin
    - Munich
    - Paris
    - London
    - Hamburg
    - Cologne

日期

要求用户输入特定日期。

- type : date
  label : When was the Berlin Wall built?

等级

为用户提供了一个规模，以便在预定义的范围内对某些内容进行评分。

- type : rating
  label : How much do you like Berlin?
  min : 1
  max : 5

排行

要求用户根据给定的标准对选项进行排名。

- type : ranking
  label : Rank the following cities by population
  optionsFromVariable : german-city-options

是/否

提出一个问题，用户只能回答“是”或“否”。

- type : yes-no
  label : Is Berlin the capital of Germany?

电子邮件

提示用户输入他们的电子邮件

- type : email
  label : Please enter your email.

文件

提示用户根据给定格式和最大上传大小上传文件。

- type : file
  label : Upload a Berlin Image
  validation :
    formats :
      - .jpg
      - .png
    max_size_bytes : 5*1024*1024 # 5 MB 

回答

响应可以在UI中显示，并以JSON的形式导出。另外，您可以使用REST API获得调查响应：

curl -XGET 
http://localhost:9900/app/surveys/{SURVEY_ID}/sessions ? limit=100 & offset=0 & sort_by=created_at & order=desc

其中{SURVEY_ID} ID给定调查的UUID。

屏幕截图

安装和部署

 docker-compose up -d --build

您应该能够在http：// localhost：3000上访问UI（默认基本验证： user:pass ）。

您可以将单个服务部署到任何云提供商或自我托管。

• 向后去。它被包装为Docker容器，可以在任何地方部署。
• Next.js前端。它也被包装为Docker容器，但也可以部署到Vercel。
• [可选] Postgres数据库。您可以使用托管的Postgres服务或自己部署。

演示服务（上面的链接）被部署为Fly.io（GO，sqlite）和Vercel（Next.js），并在免费层下。

后端开发设置

从这里安装本地空气

安装空气后运行以下命令

 cd api
air

每当使用air在API中进行更改时，此命令将有助于实时重新加载。可以通过修改air.toml文件来设置自定义配置

环境变量

API：

• DATABASE_TYPE sqlite或postgres
• DATABASE_URL Postgres或Sqlite连接字符串
• LOG_LEVEL日志级别，例如info
• SURVEYS_DIR带有调查的目录，例如/root/surveys 。建议将安装卷用于此目录。

ui：

• CONSOLE_API_ADDR GO后端的公共地址。需要从浏览器访问。
• CONSOLE_API_ADDR_INTERNAL go后端的内部地址，例如http://api:8080 （可能与CONSOLE_API_ADDR相同）。
• IRON_SESSION_SECRET会话加密的秘密
• HTTP_BASIC_AUTH格式： user:pass

技术堆栈

• 后端：GO，（Postgres或Sqlite）
• UI：Next.js，tailwind CSS

创建新的sqlite/postgres迁移

确保首先安装移民。

 cd api
migrate create -dir migrations/postgres -ext sql -seq name
migrate create -dir migrations/sqlite -ext sql -seq name

运行GO测试

 cd api
make test

贡献准则

欢迎拉扯请求，错误报告和所有其他形式的贡献。