formulosityダウンロード - formulosityソースコードのダウンロード

formulosity

AI ソースコード

v0.1.10

ダウンロード

Formulosityは、従来の調査ビルダーの代わりにコードを使用して調査を構築および展開するための自己ホストアプリです。

このアプローチには、以下を含む多くの利点があります。

バージョン制御：調査ファイルはGitHubリポジトリに保存できます。これにより、変更を簡単に追跡し、他の人とコラボレーションできます。
再現性：調査ファイルは簡単に共有および再現でき、調査を簡単に再利用したり、既存の調査のバリエーションを作成したりできます。
自動化：調査ファイルは、調査の作成と展開を自動化するために使用できます。これにより、時間と労力を節約できます。

Formulosityは、人間の読み取り可能な宣言言語YAMLを使用します。

特徴

動作中にそれを見てください！

管理パネル

注： user / passを使用して、コンソールUIにログインします。

調査構造

SURVEYS_DIRの各ディレクトリは調査です。 SURVEYS_DIRな調査を設定することにより、調査のソースを構成できます。

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

開始するには、複数の例を備えた./surveysフォルダーをご覧ください。

調査ファイル

Metadata.yaml

このファイルが必要です！このファイルは、調査を説明する特定のプロパティを持つ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

このファイルが必要です！ファイルは質問のリストで構成され、それぞれが特定のプロパティを持つYAMLオブジェクトとして定義されています。

タイプ：これは、質問されている質問の種類を指定します。
ID ：これは、質問の一意の識別子を提供します。分岐ロジックまたはデータ分析の特定の質問を参照するのに役立ちます。 IDは、調査のすべての質問にわたって一意でなければなりません。
ラベル：これは、質問自体としてユーザーに表示されるテキストです。
説明：これは、明確化や指示など、ユーザーの質問に関する追加情報を提供します。
オプション：このリストはsingle-choice 、 multiple-choice 、 rankingなどの質問タイプの利用可能な回答の選択肢を定義します。
optionsfromvariable ：このプロパティは、個別の変数で定義された変数を参照しています。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 ：このプロパティは、プラットフォームが同じユーザーからの重複応答を処理する方法を定義します。

 duplicateProtection : cookie # cookie | ip

variables.yaml

このファイルはオプションです。ファイルは変数のリストで構成され、それぞれが特定のプロパティを持つ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

単一の選択

オプションのリストから1つの正解のみで質問を提示します。

- 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 : 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}特定の調査のuuidをidにします。

スクリーンショット

インストールと展開

 docker-compose up -d --build

また、http：// localhost：3000でUIにアクセスできるはずです（デフォルトの基本認証： user:pass ）。

個々のサービスをクラウドプロバイダーに展開するか、自己ホストすることができます。

バックエンドに行きます。 Dockerコンテナとしてパッケージ化されており、どこにでも展開できます。
next.js frontend。また、Dockerコンテナとしてパッケージ化されていますが、たとえばVercelに展開することもできます。
[オプション] 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調査、eg /root/surveysを備えたディレクトリ。このディレクトリにマウントボリュームを使用することをお勧めします。

UI：

CONSOLE_API_ADDR Go Backendのパブリックアドレス。ブラウザからアクセスできる必要があります。
CONSOLE_API_ADDR_INTERNAL go backendの内部アドレス、例http://api:8080 （ CONSOLE_API_ADDRと同じ可能性があります）。
IRON_SESSION_SECRETセッション暗号化の秘密
HTTP_BASIC_AUTH -format： 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

貢献ガイドライン

リクエスト、バグレポート、およびその他のすべての形式の貢献が歓迎され、強く奨励されています！

拡大する

追加情報

バージョン v0.1.10
タイプ AI ソースコード
更新時間 2025-08-18
サイズ 984.62KB
から Github

formulosity

特徴