aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 234befff9ce0fa77e972d4bf65aa989a03a84e01 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
1# PBLive
2
3PBLive is an open-source self-hosted live online quiz tool, similar to Kahoot and Socrative.
4
5## Installing and running
6
7    virtualenv venv
8    . venv/bin/activate
9    pip install -r requirements.txt
10    python -m pblive.__init__
11
12Navigate to http://1.2.3.4:5000/admin to begin.
13
14## Example
15
16Place in `data/example.yaml`, where the `data` directory is a sibling of this README:
17
18    title: Example quiz
19    questions:
20    - type: landing
21    - type: mcq
22      prompt: This is a multiple-choice question
23      answers: [A, B, C, D]
24    - type: type
25      prompt: This is a basic short answer question
26    - type: type
27      prompt: The answer to this short answer question is a percentage
28      answer_form: $1%
29      answer_type: number
30      answer_range: [0, 100]
31    - type: draw
32      prompt: Draw on the diagram
33      image: some_image.gif
34    - type: speed
35      prompt: A speed quiz is like multiple-choice, but starts a two second countdown once the first answer is submitted to each question.
36      answers: [Option 1, Option 2, Option 3]
37    - type: speed
38      prompt: This will automatically continue until the last speed question in a row is completed.
39      answers: [Option 1, Option 2, Option 3]
40    - type: speed
41      prompt: The answers to the speed questions are reviewed in a review stage following the final question.
42      answers: [Option 1, Option 2, Option 3]
43    - type: speed_review
44
45Files like `some_image.gif` should be placed within the `img` subfolder of `data`.
46
47## Security
48
49There is none. Watch this space.
50
51## Licence
52
53    Copyright © 2017  RunasSudo (Yingtong Li)
54
55    This program is free software: you can redistribute it and/or modify
56    it under the terms of the GNU Affero General Public License as published by
57    the Free Software Foundation, either version 3 of the License, or
58    (at your option) any later version.
59
60    This program is distributed in the hope that it will be useful,
61    but WITHOUT ANY WARRANTY; without even the implied warranty of
62    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
63    GNU Affero General Public License for more details.
64
65    You should have received a copy of the GNU Affero General Public License
66    along with this program.  If not, see <http://www.gnu.org/licenses/>.
Contact (issues, pull requests, etc.) at git@yingtongli.me. Generated by cgit.