Code Monkey home page Code Monkey logo

ridlr's Introduction

Ridlr

Ridlr is simple Online Tutoring & Quiz application written in Django

Setting up

Ridlr setup is relatively simpler. It used Django for API layer, specifically we're using Django REST Framework. Frontend is written using ReactJS.

Backend

  1. Create virtualenv python3.7 -m venv venv
  2. Activate virtualenv source ./venv/bin/activate
  3. Create Database cd webapp/ridlr && python manage.py migrate
    1. NOTE: Change settings.py if you would like to run Ridlr with different Database
  4. Create Superuser python manage.py createsuperuser
  5. Load Quiz using following management command python manage.py load_quiz ./master_templates/Quiz-Template.tsv
    1. Replace with any Quiz Template that you might have created
  6. Start Django python manage.py runserver 0.0.0.0:8000

Frontend

  1. Change to right directory cd webapp/ridlr/frontend/ridlr
  2. Install Dependencies yarn install
  3. Start the frontend yarn serve

Models

  1. Category: Category related to a Quiz. E.g. Programming
  2. SubCategory: Sub-Category associated with Quiz E.g. Python/Collections
  3. Quiz: Quiz is self-explainatory
  4. QuizStructure: It is the structure that is used to build QuestionBank. It basically tell us how many questions of a given SubCategory do we need to include.
  5. QuestionType: Right now its only MCQ {Multiple Choice Question}, we will be implementing Open and Code questions
  6. Question: Object of Question that gets added to QuestionBank
  7. Choice: Object of Choice associated with Question and information if its correct
  8. QuestionBank: This gets generated and rendered to frontend via API
  9. Invitation: We use Invitation codes as opposed to Passwords for authenticating users.
  10. TestSession: Meta-data related to test sessions. E.g. When a given Test Session got started and completed
  11. QuestionResponse: Log of all responses for a given Question. This is used for audit-trail.

Quiz Template Creation Guide

A typical Quiz Template looks like follows

Quiz-Template-Screenshot

Key things to note:

  1. Quiz Name
  2. Timed: Tells if the Quiz is Timed
  3. Max Time In Mins: If Quiz is timed, what is the maximum allowable time?
  4. Quiz Structure: In this section we have one row per Sub Category.
    1. E.g. Python/Basics 1 implies select one question of category Python/Basics
  5. Category Sub Category Question Type Point Question Choices Correct is where you start populating your quiz database

ridlr's People

Contributors

sidharthshah avatar fafadiatech avatar

Watchers

 avatar James Cloos avatar Yogesh Panchal avatar  avatar  avatar Gaurav avatar  avatar Jitendra Varma avatar

ridlr's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.