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

貢獻準則

歡迎拉扯請求，錯誤報告和所有其他形式的貢獻。