About Edulearn

Edulearn is a Flask application that allows users to revise questions on a variety of STEM topics.

It allows users to view data on questions they get (in)correct to give insights on topics that need further improvement.

Check out the Usage section for further information, including Installation instructions.

Documentation for each layer of the application is broken down in their respective sections, see Frontend, Backend, and Database.

Contents

• Usage
  • Installation
  • Testing
• Frontend
  • Navbar/base
  • Front page
    • Hero section
    • Feature cards
    • Call to action
  • Start Quiz form
  • Quiz form
    • Quiz form JS
      • showQuestion
      • Finish/Next button clicks
      • Answer selection event
    • Styling
  • Feedback list
  • Feedback detail view
  • Login form
• Backend
  • Routes
    • Front page view ‘/’ (index.html)
    • Quiz summaries view ‘/feedback’ (feedback.html)
    • Quiz feedback detail view ‘/quiz_feedback’ (quiz_feedback.html)
    • Login form view ‘/login’ (login.html)
    • Quiz form view ‘/quiz’ (quiz.html + start_quiz.html)
    • Quiz topic selection view ‘/start_quiz’ (start_quiz.html)
    • Individual question ‘/question/<int:question_id>’ (quiz.html)
  • API
    • Submit quiz ‘/api/submitQuiz’
    • Health check ‘api/health’
  • Query helpers
    • Database path resolvers
      • _default_db_path
      • _resolve_db_path
    • connector
    • get_cursor
    • Question queries
      • DB_query_questions_list
      • DB_query_question_by_id
    • Feedback queries
      • DB_query_insert_feedback
      • DB_query_user_quiz_summaries
      • DB_query_quiz_feedback_detail
  • Misc
    • create_app
    • transform_db_question
• Database
  • ERD
  • ACCOUNTS TABLE
  • FEEDBACK/QUIZ TABLE
  • QUESTIONS TABLE
  • TOPIC TABLE