62 lines
1.7 KiB
Cheetah
62 lines
1.7 KiB
Cheetah
|
{{define "description"}}
|
||
|
|
# Probo
|
||
|
|
|
||
|
|
`probo` is a quiz management and administration system designed for
|
||
|
|
command line and text interface enthusiasts. `probo` aims to highlight
|
||
|
|
themes such as privacy, interoperability, accessibility,
|
||
|
|
decentralization, and quick usage speed.
|
||
|
|
|
||
|
|
`probo` organizes information in plain text files and folders so that
|
||
|
|
data can be easily revised through version control systems. Quizzes
|
||
|
|
can be written in Markdown format, filters use the `jq` language, exam
|
||
|
|
sessions, participants, and their quiz answers are JSON files.
|
||
|
|
|
||
|
|
`probo` contains a built-in web server that allows quizzes to be
|
||
|
|
administered to participants and their answers received.
|
||
|
|
|
||
|
|
`probo` is a self-contained application that can be distributed through
|
||
|
|
a simple executable containing all necessary assets for its operation.
|
||
|
|
|
||
|
|
# Quickstart
|
||
|
|
|
||
|
|
1. Initialize the working directory
|
||
|
|
|
||
|
|
```
|
||
|
|
probo init
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Create our first quiz.
|
||
|
|
|
||
|
|
```
|
||
|
|
probo create quiz > data/quizzes/quiz_1.md
|
||
|
|
```
|
||
|
|
|
||
|
|
3. Create two participants.
|
||
|
|
|
||
|
|
```
|
||
|
|
probo create participant > data/participants/john.json
|
||
|
|
probo create participant > data/participants/mary.json
|
||
|
|
```
|
||
|
|
|
||
|
|
4. Filter participants and quizzes (in this case, all participants and
|
||
|
|
all quizzes present in the store will be selected) and create an exam
|
||
|
|
session.
|
||
|
|
|
||
|
|
```
|
||
|
|
probo filter participant -f '.' | probo filter quizzes -f '.' | probo create session --name="My First Session" > data/sessions/my_session.json
|
||
|
|
```
|
||
|
|
|
||
|
|
5. Run the web server to allow participants to respond.
|
||
|
|
|
||
|
|
```
|
||
|
|
probo serve
|
||
|
|
```
|
||
|
|
|
||
|
|
6. Share the *qrcode* generated from the previous step with the participants and wait for them to finish responding.
|
||
|
|
|
||
|
|
7. Explore the results.
|
||
|
|
|
||
|
|
```
|
||
|
|
probo filter responses -f '.' | probo rank
|
||
|
|
```
|
||
|
|
{{end}}
|