Quickstart ========== In this document, we will walk show how to use ``quickmode`` command to make a learning module. .. include:: aurum_cli_commands.rst :start-after: begin-cli-commands :end-before: end-cli-commands Basic workflow: 1. clone/fork `official test repo `_ and write your tests. See :ref:`` 2. download and edit scorm LMS. `repo on bitbucket `_ | `download as zip `_ 3. edit ``scorm.yaml`` and run ``aurum-cli quickmode ...`` 4. upload to BlackBoard and test scorm ============ Step-by-Step Tutorial ===================== Before proceeding to the actual tutoria, make sure you have read * :doc:`intro_to_lms` * :doc:`install` * :doc:`glossary` Assumptions ----------- Throughout this whole tutorial, I will work from my home directory `/home/yeukhon/work`. You can choose to work from any where on your system. I created a directory called `work` to hold the tutorial stuff. Step 1: Install Aurum-cli ------------------------- If you haven't installed ``aurum-cli``, please read :doc:`install`. Step 2: Download the latest Scorm LMS ------------------------------------- .. note:: If you are new to scorm LMS, please read :doc:`intro_to_lms`. We are providing a pre-pakcaged sample Scorm LMS on Bitbucket `here `_. 1. Click `Download `_ to get the latest sample in zip format. 2. Unzip the zip file. 3. Rename the folder to **basic_scorm** for now. You can also do this via command-line: .. code-block:: bash yeukhon@fubini:/home/yeukhon/work$ wget https://bitbucket.org/glasslab/sample-basic-scorm/get/default.zip -O basic_scorm.zip yeukhon@fubini:/home/yeukhon/work$ unzip basic_scorm.zip; mv glasslab-sample-basic-scorm-* basic_scorm At this point, you should have a new directory called **basic_scorm**. We will call the full path of this new directory the ``scorm_dir``. In our example, this would be ``/home/yeukhon/work/basic_scorm``. Step 3: Edit the LMS index.html ------------------------------- Yes. Time to write some html for your class! Once again, a basic LMS should contain an objective, prodecures and examples. If you use our `basic_scorm`, there two things you have to touch. .. code-block:: html

Secondly, you may want to change the default title of the webpage! .. code-block:: html Assignment Step 4: Package Scorm LMS ------------------------- We try our best to keep configuration as minimal as possible. This is why we created ``quickmode`` command for our Aurum users. However, to use ``quickmode``, users have to fill out a configuration file called **scorm.yaml**. Fill in scorm.yaml ~~~~~~~~~~~~~~~~~~ The pre-packaged scorm zip file contains **scorm.yaml** already. You can find it inside `socrm_dir/scorm.yaml` (e.g. in this case, `/home/yeukhon/work/basic_scorm/scorm.yaml`. The file should look like this: .. code-block:: yaml server_ip: "https://134.74.77.21/beta/" # default to production username: "myusername" repo_ssh_url: "ssh://hg@bitbucket.org/yeukhon/hw1" max_score: 45 min_score: 35 scorm_dir: "/home/yeukhon/work/basic_scorm" zip_name: "hw1_scorm.zip" +-------------------+--------------------------------------------+ | attribute | purposes | +===================+============================================+ | server_ip | Default to ``https://134.74.77.21/beta/`` | | | which | | | is the domain for the current production | | | server. This is only useful for developers | | | working with their development server. | +-------------------+--------------------------------------------+ | username | Aurum username. If you don't have an | | | account yet, you can left it blank by | | | saying ``username: ""``. When you run | | | `quickmode` command, you will specify | | | ``--new-user=my-user-name`` to create | | | one. | +-------------------+--------------------------------------------+ | repo_ssh_url | The remote teacher repository. It must | | | be a mercurial repository and hosted on | | | Bitbucket at the moment. The format must | | | following | | | ``ssh://hg@bitbucket.org/bbuser/reponame`` | +-------------------+--------------------------------------------+ | max_score | The maxmium score a student can earn | | | from completing LMS. This value should | | | match the total score in your | | | config.yaml. | +-------------------+--------------------------------------------+ | min_score | The minimum passing score ranging from | | | 0 to the value of maxScore. | +-------------------+--------------------------------------------+ | scorm_dir | Full path of where Scorm LMS folder lives. | +-------------------+--------------------------------------------+ | zip_name | The name of the output Scorm LMS after | | | running ``quickmode``. A Scorm LMS is | | | packaged as a **.zip** file before we | | | could upload it to BlackBoard or Moodle. | | | Defaults to scorm.zip | +-------------------+--------------------------------------------+ .. _run-quickmode-label: Run ``quickmode`` ~~~~~~~~~~~~~~~~~ Once we finished editing `index.html` and `scorm.yaml`, we can now run our ``quickmode`` command to register an exercise object and package our Scorm LMS (and optionally create a new account). For this tutorial, we will create a new account. If you already have one, please use your existing one. The ``quickmode`` command has the form: .. code-block:: bash aurum-cli quickmode [--new-user=] [--zip] Refer to :doc:`aurum_cli_commands` to learn all the details. As of this tutorial, we run .. code-block:: bash yeukhon@fubini:/home/yeukhon/work$ aurum-cli quickmode /home/yeukhon/work/basic_scorm --new-user=my-new-acc-name --zip This command will: 1. create a new account called `my-new-acc-name`. 2. create an exercise object which holds records such as the SSH url to the teacher repo on Bitbucket. 3. configure `scorm_dir/config.js` by writing the unique exercise id and access_code, for example. 4. zip the `scorm_dir` in the way SCORM LMS accepts. .. warning:: If you prefer to zip the Scorm LMS manually, please read :ref:`how_to_zip_lms`. Scorm LMS zip requires special attention. Step 5: Share Your Repo ----------------------- We are almost there! Since most of the teacher repos will be kept private, in order for our Aurum system to access your test file, you must give **READ** access to our Bitbucket account called ``teamglass7311``. .. note:: You can find some relevant BitBucket usages from :doc:`bb_how_to`.\ .. include:: bb_how_to.rst :start-after: begin-give-access :end-before: end-give-access Once again, in scorm.yaml, you should write the repo url in ``ssh://hg@bitbucket.org/bbuser/reponame`` format! .. warning:: If you forget to give **READ** access to teamglass7311, Aurum will not be able to run your test! It will return error. Before you make your LMS visible to your students, you should run it on BlackBoard. Step 6: Upload to BlackBoard ---------------------------- Yes. Just one more tedious step. When we finished running ``quickmode``, we can find a zip file right inside our `scorm_dir`. If you have been following this tutorial, the full path to the zip file is **/home/yeukhon/work/basic_scorm/hw1_scorm.zip**. .. note:: See the screencast on how to upload to BlackBoard. Read :ref:`blackboard-guide-label` for full details.