Commit 770aa4cb authored by Sanchit's avatar Sanchit

Uploading user documentation

parent 81647fa5
\documentclass[titlepage]{article}[6pt]
\usepackage{geometry}
\geometry{ portrait, margin=0.8in}
\usepackage{silence}
\WarningFilter{latex}{Command \InputIfFileExists}
\usepackage{fontspec}
\usepackage{xunicode}
\usepackage{multicol}
\usepackage{polyglossia}
\usepackage{sectsty}
\usepackage{amsmath}
\usepackage{blkarray}
\usepackage{csquotes}
\usepackage{graphicx}
\usepackage{float}
\DeclareMathOperator*{\argmax}{argmax} % thin space, limits underneath in displays
\sectionfont{\fontsize{14}{15}\selectfont}
%%% For those cool-looking menus and keystrokes
\usepackage{menukeys}
%%% For the xelatex (and other LaTeX friends) logos
\usepackage{hologo}
%%% For the awesome fontawesome icons!
\usepackage{fontawesome}
\usepackage[hyphens]{url}
\setmainlanguage{english}
\setotherlanguages{arabic,hindi,sanskrit,greek,thai} %% or other languages
% Main serif font for English (Latin alphabet) text
\setmainfont[Ligatures=TeX]{Noto Serif}
\setsansfont[Ligatures=TeX]{Noto Sans}
\setmonofont{Noto Mono}
% define fonts for other languages
\newfontfamily\arabicfont[Script=Arabic]{Noto Naskh Arabic}
\newfontfamily\devanagarifont[Script=Devanagari]{Noto Serif Devanagari}
% \newfontfamily\greekfont[Script=Greek]{GFS Artemisia}
\newfontfamily\thaifont[Script=Thai]{Noto Serif Thai}
%%% CJK needs a different treatment
\usepackage[space]{xeCJK}
%%% Assuming Chinese is the main CJK language...
\setCJKmainfont[
BoldFont=WenQuanYi Zen Hei,
ItalicFont=AR PL KaitiM GB]
{AR PL SungtiL GB}
\setCJKsansfont{Noto Sans CJK SC}
\setCJKmonofont{cwTeXFangSong}
%%% Define fonts for Japanese and Korean
\newCJKfontfamily\japanesefont{IPAMincho}
%%% You can also upload your own font files
% \newCJKfontfamily\koreanfont{[UnGraphic.ttf]}
%%% ...or go along with a font available on the server
\newCJKfontfamily\koreanfont{Baekmuk Batang}
\font\myfont=cmr12 at 48pt
\begin{document}
\begin{titlepage}
\begin{center}
\vspace*{\fill}
\begin{figure}[H]
\centering
\includegraphics[width=0.5\columnwidth]{logo_blue}
\end{figure}
\Large{SOFTWARE LAB PROJECT}
\Large{INDIAN INSTITUTE OF TECHNOLOGY, BOMBAY}
\vspace{1.5cm}
\Large{TEAM: SPARTAN BOTS}
\begin{table}[h]
\Large
\centering
\begin{tabular}{ c c }
\textbf{Samarth Joshi} & 203059008 \\
\textbf{Sanchit Gupta} & 203050089 \\
\textbf{Roshan Sahu} & 203050048
\end{tabular}
\end{table}
\vspace{2cm}
\Large{18th November, 2020}
\vspace*{\fill}
\end{center}
\end{titlepage}
\newpage
%\begin{multicols}{2}
\section{Introduction}
A basic quiz application allows you to conduct a quiz, but does not give the professor a clear picture about what topics students have understood thoroughly and topics in which students are lagging. And also afterquiz cribs is a quite cumbersome process. Hence our system Pariksha would provide a quiz hosting as well as afterquiz analysis for the professor as well as the students. Thus helping the professor analyse how much the students have grasped particular topics and which topics they are lagging. And also providing afterquiz cribs for faster resolution of doubts.
\section{Motivation}
Due to global pandemic online education has seen an exponential increase, we need to leverage technology to test students.
Any test taking application should allow the professor to host a quiz which the students can take. \\
And after the quiz, analysis should be provided to both student and professor which contains details about various attributes related to the quiz. It is visualized using graphs and charts from which professors can make judgement about the students' understanding about the topic.\\
For professors, the dashboard would allow him to analyse students understanding about the topics using per quiz charts/graphs, which will give detailed description of the performance of enrolled students. Also the professor will be able to address the cribs for the quiz.\\
For students, they could take quiz hosted by professors. The student can raise doubts in afterquiz cribs session. Students can view their performance in all the quiz.
\section{Dependencies}
\begin{itemize}
\item Python3
\item Django
\end{itemize}
\section{Using Pariksha}
Pariksha is very easy to use platform. You need to have installed the dependencies.
To install python3 on ubuntu, run the following command in your terminal.
\begin{itemize}
\item \textbf{\textit{sudo apt-get install python3.8}}
\end{itemize}
To install Django on ubuntu, run the following command in your terminal.
\begin{itemize}
\item \textbf{\textit{sudo apt-get install python3-django}}
\end{itemize}
One needs to git clone the project. After that open terminal in main directory and run following commands.
\begin{itemize}
\item \textbf{\textit{python3 manage.py makemigrations}}
\item \textbf{\textit{python3 manage.py migrate}}
\item \textbf{\textit{python3 manage.py runserver}}
\end{itemize}
All the functionalities and how to use them is depicted ahead.
\subsection{Student}
The student first needs to sign up.
\begin{figure}[H]
\centering
\includegraphics[width=0.9\columnwidth]{signUp}
\caption{Sign-up Page}
\end{figure}
After successfully signing up student redirected to Student homepage.
\begin{figure}[H]
\centering
\includegraphics[width=0.9\columnwidth]{student_dash}
\caption{Student Dashboard}
\end{figure}
\newpage
Next time a student only needs to login with previously using credentials.
\begin{figure}[H]
\centering
\includegraphics[width=0.9\columnwidth]{signin.png}
\caption{Login Page}
\end{figure}
A student can select from the list of ongoing quizzes the quiz of his/her choice.
\begin{figure}[H]
\centering
\includegraphics[width=0.9\columnwidth]{ongoing.png}
\caption{Ongoing Quizzes}
\end{figure}
\newpage
The quiz starts at the scheduled time and a timer is started and students can attempt the quiz till the timer ends which will auto submit the quiz.
\begin{figure}[H]
\centering
\includegraphics[width=0.9\columnwidth]{quiz.png}
\caption{Ongoing Quizzes}
\end{figure}
A student can also view details of marks obtained in the previous quizzes from homepage.
\begin{figure}[H]
\centering
\includegraphics[width=0.9\columnwidth]{submission.png}
\caption{Previous Submissions}
\end{figure}
\newpage
\subsection{Professor}
A professor needs to sign up first as a professor.
After successfully signing-up the professor redirect to professor homepage.
\begin{figure}[H]
\centering
\includegraphics[width=0.9\columnwidth]{prof_dash}
\caption{Professor Dashboard}
\end{figure}
Professor can create a new quiz by clicking on Create quiz in homepage.
A professor can add questions in the quiz in two ways.\\
1- Manually
\begin{figure}[H]
\centering
\includegraphics[width=0.9\columnwidth]{ques_man}
\caption{Adding quiz questions manually}
\end{figure}
\newpage
2- By uploading CSV file
\begin{figure}[H]
\centering
\includegraphics[width=0.9\columnwidth]{ques_csv}
\caption{Adding quiz questions using CSV}
\end{figure}
Professor can view how its students have performed in previous quizzes by an extensive analysis using various graphs.
Professor can also see corresponding cribs of students in that quiz.
\begin{figure}[H]
\centering
\includegraphics[width=0.9\columnwidth]{graphs}
\caption{Analysis Graphs and Cribs Table}
\end{figure}
Professor can monitor its students in his/her currently ongoing quizzes.
\begin{figure}[H]
\centering
\includegraphics[width=0.9\columnwidth]{monitor}
\caption{Monitor Page}
\end{figure}
\section{Future Scope}
\begin{itemize}
\item The questions could be provided with \LaTeX\ editor.
\item Functionality to support numeric answer type.
\item Video proctoring of the student.
\end{itemize}
\end{document}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment