README.md

Quizzes Tutor

Vue.js web application and Spring-boot API

with multiple choice questions for students

and quiz management for teachers

About • Technologies • Installation • Patreons • Contributing • License

About

Quizzes Tutor allows teachers to create and reuse, multiple-choice questions with images and topics which can be inserted in assessments and quizzes. Its development started as an effort of project IMPRESS to share and reuse questions and quizzes of software engineering.

It is currently integrated with IST authentication such that it can be used for any course.

Students can then answer those questions in sugested quizzes or generated quizzes (pseudo-random) providing them with a useful self-assessment tool to improve their learning.

Technologies

• Require download
  • Postgres >= 10
  • Java 11
  • Maven
  • Node 12.14 (Node Version Manager recommended)
  • Docker
• No download required
  • Spring-boot
  • Vue.js

Installation

• Install

sudo apt update && sudo apt upgrade
sudo apt install openjdk-11-jdk postgresql

• Start db, change to postgres user and create DB

sudo service postgresql start
sudo su -l postgres
dropdb tutordb
createdb tutordb

• Create user to access db and load dump

psql tutordb
CREATE USER your-username WITH SUPERUSER LOGIN PASSWORD 'yourpassword';
\q
exit
psql tutordb < dump.sql

• Go to API Service Agreement and then to Applications and create an application that redirects to http://localhost:8081/login and accessess curricular and information
• Rename backend/src/main/resources/application-dev.properties.example to application-dev.properties and fill its fields
• Run server

cd backend
mvn clean spring-boot:run

• See documentation on http://localhost:8080/swagger-ui.html
• Rename frontend/example.env to .env and fill its fields
• Run frontend

cd frontend
npm i
npm start

• Access http://localhost:8081

Patreons

A special thanks to our patreons for supporting this project:

Contributing

Your contributions are always welcome! Please have a look at the contribution guidelines first.

License

This project is licensed under the MIT License - see the LICENSE file for details.