diff options
Diffstat (limited to 'yaksh/documentation/_build/html/installation.html')
| -rw-r--r-- | yaksh/documentation/_build/html/installation.html | 296 |
1 files changed, 296 insertions, 0 deletions
diff --git a/yaksh/documentation/_build/html/installation.html b/yaksh/documentation/_build/html/installation.html new file mode 100644 index 0000000..317c688 --- /dev/null +++ b/yaksh/documentation/_build/html/installation.html @@ -0,0 +1,296 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Installation — Yaksh July 2016 documentation</title> + + + + + + + + + + + + + + + + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + + + + + + <link rel="top" title="Yaksh July 2016 documentation" href="index.html"/> + <link rel="next" title="Moderator’s Dashboard" href="moderator_dashboard.html"/> + <link rel="prev" title="Introduction" href="introduction.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search"> + + + + <a href="index.html" class="icon icon-home"> Yaksh + + + + </a> + + + + + <div class="version"> + 0.1.2 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#installing-yaksh">Installing Yaksh</a></li> +<li class="toctree-l2"><a class="reference internal" href="#quick-start">Quick Start</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="moderator_dashboard.html">Moderator’s Dashboard</a></li> +<li class="toctree-l1"><a class="reference internal" href="about_yaksh.html">About Yaksh</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">Yaksh</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="index.html">Docs</a> »</li> + + <li>Installation</li> + <li class="wy-breadcrumbs-aside"> + + + <a href="_sources/installation.txt" rel="nofollow"> View page source</a> + + + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="installation"> +<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1> +<div class="section" id="installing-yaksh"> +<h2>Installing Yaksh<a class="headerlink" href="#installing-yaksh" title="Permalink to this headline">¶</a></h2> +<p><strong>Pre-Requisite</strong></p> +<ul class="simple"> +<li>Ensure <a class="reference external" href="https://pip.pypa.io/en/latest/installing.html">pip</a> is installed</li> +</ul> +<p><strong>For installing Yaksh</strong></p> +<blockquote> +<div><ul> +<li><p class="first">For latest stable release:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span>$ pip install yaksh +</pre></div> +</div> +</li> +<li><p class="first">For the development version:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span>$ pip install git+https://github.com/FOSSEE/online_test.git +</pre></div> +</div> +</li> +</ul> +</div></blockquote> +</div> +<div class="section" id="quick-start"> +<h2>Quick Start<a class="headerlink" href="#quick-start" title="Permalink to this headline">¶</a></h2> +<p><strong>In the terminal run</strong>:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">yaksh</span> <span class="n">create_demo</span> <span class="p">[</span><span class="o">-</span><span class="n">p</span> <span class="n">PATH</span><span class="p">]</span> <span class="p">[</span><span class="n">project_name</span><span class="p">]</span> +</pre></div> +</div> +<ul> +<li><dl class="first docutils"> +<dt><strong>project_name</strong></dt> +<dd><p class="first last">The desired name of the django project. In case a project_name is not specified, the project is initialised with the name yaksh_demo</p> +</dd> +</dl> +</li> +<li><dl class="first docutils"> +<dt><strong>PATH</strong></dt> +<dd><p class="first last">An optional flag to specify where the django project will be installed. If PATH is not provided, the project is created in the current directory</p> +</dd> +</dl> +</li> +</ul> +<p><strong>Now execute</strong>:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span>$ yaksh run_demo +</pre></div> +</div> +<p>This starts the web server at localhost</p> +<p><strong>In a new terminal, execute</strong>:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span>$ sudo yaksh run_code_server +</pre></div> +</div> +<p>This starts the code server</p> +<p><strong>Open your browser and go to URL</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">localhost</span><span class="p">:</span><span class="mi">8000</span><span class="o">/</span><span class="n">exam</span> +</pre></div> +</div> +<p><strong>Login as a teacher to edit the quiz or as a student to take the quiz Credentials:</strong></p> +<blockquote> +<div><dl class="docutils"> +<dt>For Student:</dt> +<dd><ul class="first last simple"> +<li>Username: student</li> +<li>Password: student</li> +</ul> +</dd> +<dt>For Teacher:</dt> +<dd><ul class="first last simple"> +<li>Username: teacher</li> +<li>Password: teacher</li> +</ul> +</dd> +</dl> +</div></blockquote> +<p><strong>User can also login to the Default Django admin by going to URL</strong>:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">localhost</span><span class="p">:</span><span class="mi">8000</span><span class="o">/</span><span class="n">admin</span> +</pre></div> +</div> +<dl class="docutils"> +<dt><strong>And entering the following admin credentials</strong></dt> +<dd><ul class="first last simple"> +<li>Username: admin</li> +<li>Password: admin</li> +</ul> +</dd> +</dl> +</div> +</div> + + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="moderator_dashboard.html" class="btn btn-neutral float-right" title="Moderator’s Dashboard" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="introduction.html" class="btn btn-neutral" title="Introduction" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2016, FOSSEE. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'./', + VERSION:'July 2016', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> + + + + + + <script type="text/javascript" src="_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html>
\ No newline at end of file |