README

README.md

@@ -13,7 +13,7 @@ Rascal implementation of a simple rule checker for student Java assignments.
 1. Run the script
 
         $ ./run.sh <two-digit-assignment-nr> <absolute-path-to-student-project>
-   
+
    For example
 
         $ ./run.sh 02 /home/mkl/radboud/teaching/object-orientation/oo-grading-2019/assignment02/thout/70827-16116\ -\ Asgn\ CS\ Group\ 125\ -\ Jordy\ Schoolmeesters\ -\ Feb\ 10\,\ 2019\ 22_55/
@@ -46,6 +46,72 @@ https://www.rascal-mpl.org/start/
 
 
 
+# Running The Brightspace Integration
+
+1. Clone repository
+
+        $ git clone --recurse-submodules https://gitlab.science.ru.nl/mklinik/personal-prof.git
+        $ cd personal-prof
+
+2. Install 3rd-party jar files and rascal. Currently, my own patched version of
+   Rascal needs to be used. For build instructions of the rascal jar see rascal
+   documentation.
+
+        # On a machine where you already have them:
+        $ scp -r src/lib/ lilo:sandbox/personal-prof/src/
+
+        # On lilo
+        $ ls -1 src/lib/
+        javafx.base.jar
+        javafx.controls.jar
+        javafx.fxml.jar
+        javafx.graphics.jar
+        javafx.media.jar
+        javafx.swing.jar
+        javafx.web.jar
+        junit.jar
+        rascal-0.15.0-SNAPSHOT.jar
+
+3. Optional: Run tests
+
+        $ ./test.sh
+
+4. Create config directories
+
+        $ mkdir -p ~/.config/grading-tools
+        $ mkdir -p ~/.config/personal-prof
+
+5. Copy config files to config direcotries
+
+        $ cd brightspace-integration
+        $ cp app.json.config ~/.config/personal-prof
+        $ cp brightspace-grading-tool/grading-tool-python/app.json.config.default ~/.config/grading-tools/app.json.config
+
+6. Edit config files
+
+        $ vim ~/.config/personal-prof/app.json.config
+        $ vim ~/.config/grading-tools/app.json.config
+
+7. Install d2lvalence python module
+
+        $ pip3 install D2LValence
+
+8. Log in
+
+        $ cd brightspace-grading-tool/grading-tool-python/
+        $ ./no-bs login-manual
+
+9. See if it works
+
+        $ ./no-bs list-courses
+        $ ./no-bs list-folders <course-id>
+
+9. Start the server
+
+        $ export PYTHONPATH=`readlink -f brightspace-grading-tool/grading-tool-python`
+        $ screen
+        $ ./personal-prof run ...
+
 
 ## References