formulosity

Formulosity เป็นแอพที่โฮสต์ตนเองสำหรับการสร้างและปรับใช้การสำรวจโดยใช้รหัสแทนผู้สร้างแบบสำรวจแบบดั้งเดิม

วิธีการนี้มีข้อดีหลายประการรวมถึง:

• การควบคุมเวอร์ชัน : ไฟล์สำรวจสามารถเก็บไว้ในที่เก็บ GitHub ซึ่งทำให้ง่ายต่อการติดตามการเปลี่ยนแปลงและร่วมมือกับผู้อื่น
• ความสามารถในการทำซ้ำ : ไฟล์สำรวจสามารถแชร์และทำซ้ำได้ง่ายทำให้ง่ายต่อการสำรวจซ้ำหรือสร้างการสำรวจที่มีอยู่เดิม
• ระบบอัตโนมัติ : ไฟล์สำรวจสามารถใช้ในการสร้างและปรับใช้การสำรวจโดยอัตโนมัติซึ่งสามารถประหยัดเวลาและความพยายามได้

Formulosity ใช้ภาษาประกาศที่มนุษย์อ่านได้ Yaml

คุณสมบัติ

• API การจัดการ
• Survey UI: สำหรับผู้ใช้ (ผู้ตอบ)
• คอนโซล UI: จัดการแบบสำรวจ
• การกำหนดค่าการสำรวจ Yaml
• ประเภทคำถามพื้นฐาน
• ธีมเริ่มต้น
• ชุดรูปแบบที่กำหนดเองสนับสนุน
• ตัวเลือกส่วนบุคคล: อินโทร, outro, ฯลฯ
• การป้องกันการตอบสนองที่ซ้ำกันของคุกกี้/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 พร้อมตัวอย่างหลายตัวอย่าง

ไฟล์สำรวจ

metadata.yaml

ต้องใช้ไฟล์นี้! ไฟล์ประกอบด้วยวัตถุ YAML ที่มีคุณสมบัติเฉพาะที่อธิบายการสำรวจ

• ชื่อเรื่อง : นี่คือชื่อหลักที่แสดงต่อผู้ใช้ที่จุดเริ่มต้นของการสำรวจ
• ชุดรูปแบบ : สิ่งนี้ระบุชุดรูปแบบภาพที่ใช้กับการสำรวจ ธีมที่รองรับในปัจจุบันคือ: ค่าเริ่มต้น
• Intro : ข้อความนี้ปรากฏเป็นบทนำก่อนคำถามแรก
• 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
• ตัวเลือก 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 : คุณสมบัตินี้กำหนดวิธีที่แพลตฟอร์มจัดการการตอบสนองที่ซ้ำกันจากผู้ใช้รายเดียวกัน

 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

ตัวเลือกเดียว

นำเสนอคำถามที่มีคำตอบที่ถูกต้องเพียงข้อเดียวจากรายการตัวเลือก

- 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 เพื่อรับการสำรวจ resposnes:

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

และคุณควรจะสามารถเข้าถึง UI บน http: // localhost: 3000 (เริ่มต้นพื้นฐานการรับรองความถูกต้อง: user:pass )

คุณสามารถปรับใช้บริการส่วนบุคคลให้กับผู้ให้บริการคลาวด์หรือโฮสต์ตนเอง

• กลับไปแบ็คเอนด์ มันบรรจุเป็นคอนเทนเนอร์ Docker และสามารถปรับใช้ได้ทุกที่
• Next.js Frontend นอกจากนี้ยังบรรจุเป็นคอนเทนเนอร์ Docker แต่ยังสามารถนำไปใช้กับ Vercel ได้เช่นกัน
• [ไม่บังคับ] ฐานข้อมูล Postgres คุณสามารถใช้บริการ postgres ที่มีการจัดการหรือปรับใช้ด้วยตัวเอง

บริการสาธิต (ลิงก์ด้านบน) ถูกปรับใช้เพื่อ fly.io (go, sqlite) และ vercel (next.js) และอยู่ภายใต้ระดับฟรี

การตั้งค่าการพัฒนาแบ็กเอนด์

ติดตั้งอากาศในพื้นที่จากที่นี่

เรียกใช้คำสั่งต่อไปนี้หลังจากการติดตั้งอากาศ

 cd api
air

คำสั่งนี้จะช่วยในการโหลดสดเมื่อใดก็ตามที่มีการเปลี่ยนแปลงใน API โดยใช้ air การกำหนดค่าที่กำหนดเองสามารถตั้งค่าได้โดยการแก้ไขไฟล์ air.toml

ตัวแปรสภาพแวดล้อม

API:

• DATABASE_TYPE - sqlite หรือ postgres
• DATABASE_URL - สตริงการเชื่อมต่อ SQLite หรือ SQLite
• LOG_LEVEL - ระดับบันทึกเช่น info
• SURVEYS_DIR - ไดเรกทอรีที่มีการสำรวจเช่น /root/surveys แนะนำให้ใช้ปริมาณที่ติดตั้งสำหรับไดเรกทอรีนี้

UI:

• CONSOLE_API_ADDR - ที่อยู่สาธารณะของ Go Backend ต้องสามารถเข้าถึงได้จากเบราว์เซอร์
• CONSOLE_API_ADDR_INTERNAL - ที่อยู่ภายในของแบ็กเอนด์ Go เช่น http://api:8080 (อาจเหมือนกับ CONSOLE_API_ADDR )
• IRON_SESSION_SECRET - ความลับสำหรับการเข้ารหัสเซสชัน
• HTTP_BASIC_AUTH - รูปแบบ: user:pass สำหรับการรับรองความถูกต้องพื้นฐาน (ไม่บังคับ)

ซ้อนเทค

• แบ็กเอนด์: ไป (postgres หรือ sqlite)
• UI: next.js, tailwind css

สร้างการโยกย้าย SQLITE/Postgres ใหม่

ตรวจสอบให้แน่ใจว่าได้ติดตั้ง GO-MIGRATE ก่อน

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

Run Go Tests

 cd api
make test

แนวทางการสนับสนุน

คำขอดึงรายงานข้อผิดพลาดและการบริจาครูปแบบอื่น ๆ ทั้งหมดได้รับการต้อนรับและได้รับการสนับสนุนอย่างสูง!