diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 84 |
1 files changed, 53 insertions, 31 deletions
@@ -4,7 +4,7 @@ Yaksh [](https://travis-ci.org/FOSSEE/online_test) [](http://yaksh.readthedocs.io/en/latest/?badge=latest) -To get a hang of the Yaksh interface please refer to the user documentation at [Yaksh Docs] (http://yaksh.readthedocs.io) +To get an overview of the Yaksh interface please refer to the user documentation at [Yaksh Docs] (http://yaksh.readthedocs.io) This is a Quickstart guide to help users setup a trial instance. If you wish to deploy Yaksh in a production environment here is a [Production Deployment Guide] (https://github.com/FOSSEE/online_test/blob/master/README_production.md) @@ -12,14 +12,14 @@ This is a Quickstart guide to help users setup a trial instance. If you wish to #### Introduction This project provides an "exam" app that lets users take an online -programming quiz. +programming quiz. #### Features * Define fairly complicated programming problems and have users - solve the problem. - * Immediate verification of code solution. - * Supports pretty much arbitrary coding questions in Python, C, C++ and + solve the problem. + * Immediate verification of code solution. + * Supports pretty much arbitrary coding questions in Python, C, C++ and simple Bash and uses "test cases" to test the implementations of the students. * Supports simple multiple choice questions and File uploads. * Since it runs on your Python, you could technically test any Python based library. @@ -29,41 +29,62 @@ programming quiz. Quick Start =========== -#### Pre-Requisite +#### Pre-Requisites -1. Ensure [pip](https://pip.pypa.io/en/latest/installing.html) is installed +1. Ensure you have Python available. +1. Ensure [pip](https://pip.pypa.io/en/latest/installing.html) is installed. #### Installation -1. Install the yaksh +1. Install yaksh - For latest stable release - + $ pip install yaksh - For the development version $ pip install git+https://github.com/FOSSEE/online_test.git -1. In the terminal run - - yaksh create_demo [-p PATH] [project_name] - - ```project_name``` is the desired name of the django project. - - In case a ```project_name``` is not specified, the project is initialised with the name ```yaksh_demo``` - - PATH is 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 +#### Short instructions + +To see a quick demo after installing yaksh do the following: + + $ yaksh create_demo yaksh_demo + $ yaksh run yaksh_demo + +On another terminal start up the code server that executes the user code safely: + + $ sudo yaksh run_code_server + +Now point your browser to ```http://localhost:8000/exam```. + +#### More detailed instructions + +1. On the terminal run: + + $ yaksh create_demo [project_path] + + - `project_path` is the desired directory of the django project the + basename of which is also the Django project name. This can be a + relative directory. + + - In case a `project_path` is not specified, the project is created + in a `yaksh_demo` subdirectory of the current directory. 1. The script does the following; - 1. Creates a new django project called `project_name` - 1. Creates a new demo database - 1. Creates two users, test moderator and test examinee - 1. Loads demo questions - 1. Loads demo quiz + 1. Creates a new django project with name as the basename of the specified + `project_path` + 1. Creates a new demo database. + 1. Creates two users, teacher and student. + 1. Loads demo questions. + 1. Loads demo quiz. -1. Run: +1. To run the server, run: - $ yaksh run_demo + $ yaksh run relpath/or/abspath/to/demo -1. In a new terminal run: +1. In a new terminal run the following command which executes user submitted + code safely: $ sudo yaksh run_code_server @@ -77,19 +98,20 @@ Quick Start 1. User can also login to the Default Django admin using; - Admin - Username: admin | Password: admin + History ======= At FOSSEE, Nishanth had implemented a nice django based app to test for multiple-choice questions. Prabhu Ramachandran was inspired by a programming contest that he saw at PyCon APAC 2011. Chris Boesch, who -administered the contest, used a nice web application -[Singpath](http://singpath.com) that he had built on top of GAE that +administered the contest, used a nice web application +[Singpath](http://singpath.com) that he had built on top of GAE that basically checked your Python code, live. This made it fun and interesting. -Prabhu wanted an implementation that was not tied to GAE and hence wrote -the initial cut of what is now 'Yaksh'. The idea being that -anyone can use this to test students programming skills and not have to worry +Prabhu wanted an implementation that was not tied to GAE and hence wrote +the initial cut of what is now 'Yaksh'. The idea being that +anyone can use this to test students programming skills and not have to worry about grading their answers manually and instead do so on their machines. The application has since been refactored and maintained by FOSSEE Developers. @@ -110,7 +132,7 @@ information is at the bottom of this file. Authors ======= - [FOSSEE Developers] (https://github.com/FOSSEE/online_test/graphs/contributors) + [FOSSEE Developers] (https://github.com/FOSSEE/online_test/graphs/contributors) -Copyright (c) 2011 FOSSEE (fossee.in) +Copyright (c) 2011-2017 FOSSEE (fossee.in) |