Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pimteam committed Dec 13, 2021
1 parent fed8b16 commit 7b3e1fb
Showing 1 changed file with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,42 @@
# Kiboko Quiz
A flask based app for quizzes, exams, surveys, and so on
## A Flask App For Quizzes, Exams, and Surveys

Create quizzes, exams and surveys in Flask. Calculate grades or results based on the collected points. Display result at the end of the quiz and optionally send emails.

## Features
- Creates quizzes, surveys, tests, polls, questionnaires, and exams.
- Single-choice questions.
- Multiple-choice questions.
- Open-end questions (essays).
- Required questions.
- Survey questions (no correct / wrong state).
- Deactivate questions.
- Randomize questions.
- Pull random questions from a pool.
- Grades / personality types.
- List of users who took the tests along with their results.
- Ajax-based loading of the quiz results.
- Mobile / touch – friendly user interface.
- Notify admin when someone takes a quiz.
- Send email to the quiz taker with their results.
- A basic bar chart is available for showing user points vs. average points on a given quiz.

This text you see here is *actually- written in Markdown! To get a feel
for Markdown's syntax, type some text into the left window and
watch the results in the right.

## Tech

Kiboko Quiz uses a number of open source projects to work properly:

- [jQuery] - The JavaScript library for DOM manipulation
- [TinyMCE](https://www.tiny.cloud/) - awesome web-based text editor
- [Flask](https://flask.palletsprojects.com/en/2.0.x/) - The python web framework

## Installation

- Install [Flask](https://flask.palletsprojects.com/en/2.0.x/) and deploy the app from sources

## License

[MIT](https://opensource.org/licenses/MIT)

0 comments on commit 7b3e1fb

Please sign in to comment.