diff options
author | ankitjavalkar | 2017-11-06 20:57:24 +0530 |
---|---|---|
committer | ankitjavalkar | 2017-11-08 18:38:54 +0530 |
commit | 0cbf0f1753cbff69d5c03c831caa82ec17cb2e93 (patch) | |
tree | 76109939adbb9d03d0e43cf70ffe1cdb619b33d1 | |
parent | 2df9850b13bffd83c244a2994d512c79840c17be (diff) | |
download | online_test-0cbf0f1753cbff69d5c03c831caa82ec17cb2e93.tar.gz online_test-0cbf0f1753cbff69d5c03c831caa82ec17cb2e93.tar.bz2 online_test-0cbf0f1753cbff69d5c03c831caa82ec17cb2e93.zip |
Updated CHANGELOG and README
-rw-r--r-- | CHANGELOG.txt | 1 | ||||
-rw-r--r-- | README.md | 49 | ||||
-rw-r--r-- | README_production.md | 7 |
3 files changed, 21 insertions, 36 deletions
diff --git a/CHANGELOG.txt b/CHANGELOG.txt index 56c8910..a227164 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -16,6 +16,7 @@ * CSV download for quiz attempts enhanced. * Updated Courses Page to show Active Courses on top. * Added a Datetime Picker to Add Course Page +* Added invoke script for quickstart and docker deployment === 0.6.0 (11-05-2017) === @@ -37,56 +37,41 @@ Quick Start #### Installation 1. Install yaksh - - For latest stable release + - Clone the repository - $ pip install yaksh + $ git clone https://github.com/FOSSEE/online_test.git - - For the development version + - Go to the online_test directory - $ pip install git+https://github.com/FOSSEE/online_test.git + $ cd ./online_test -#### Short instructions - -To see a quick demo after installing yaksh do the following: + - Install the dependencies - $ yaksh create_demo yaksh_demo - $ yaksh run yaksh_demo + $ pip install -r ./requirements/requirements-py3.txt -On another terminal start up the code server that executes the user code safely: +#### Short instructions - $ sudo yaksh run_code_server +1. To see a quick demo after installing yaksh do the following: -Now point your browser to ```http://localhost:8000/exam```. + $ invoke serve -#### More detailed instructions +1. On another terminal start up the code server that executes the user code safely: -1. On the terminal run: + - To run the code server in a sandboxed docker environment, run the command: - $ yaksh create_demo [project_path] + $ invoke start - - `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. + - Make sure that you have docker installed on your system beforehand - - 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 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. + - To run the code server without docker, locally use: -1. To run the server, run: + $ invoke start --unsafe - $ yaksh run relpath/or/abspath/to/demo + - Note this command will run the yaksh code server locally on your machine + and is susceptible to malicious code. -1. In a new terminal run the following command which executes user submitted - code safely: - $ sudo yaksh run_code_server 1. Open your browser and open the URL ```http://localhost:8000/exam``` diff --git a/README_production.md b/README_production.md index ed19523..8b79785 100644 --- a/README_production.md +++ b/README_production.md @@ -167,19 +167,18 @@ To install this app follow the steps below: #### Using Dockerized Code Server - 1. Install [Docker] (https://github.com/FOSSEE/online_test/blob/master/README.md) + 1. Install [Docker](https://github.com/FOSSEE/online_test/blob/master/README.md) 1. Got to the directory where the project is located cd /path/to/online_test 1. Create a docker image. This may take a few minutes - docker build -t yaksha:v1 . + docker build -t yaksh_code_server . 1. Check if the image has been created using the output of, docker images - 1. Run a container using the newly created image. - sudo docker run -d -p 53579:53579 -p 8001:8001 yaksha:v1 + 1. Run the invoke script using the command ```invoke start``` The command will create and run a new docker container (that is running the code_server.py within it), it will also bind the ports of the host with those of the container #### Additional commands available |