scholawrite

This repository provides code for collecting writing trajectory data provided by scholars. You can check our first prototype system Reward and a preliminary version of our work in our in2writing paper and demo.

Requirements

You will need to install flask==2.1.3, werkzeug==2.1.2, and flask-restx. Installing flask may automatically install a newer version of werkzeug. Werkzeug can be downgraded by running pip install werkzeug==2.1.2.

Installation Instructions

• To run the development environment, run FLASK_APP=App.py flask run in the root directory
• Then make sure the chrome extension is loaded.
• If problems are seen with some packages not being seen, npm install all packages in the package.json in the /extension folder

Loading and Using the Chrome Extension

Once the server is running, you can load the Chrome extension, open Overleaf in Chrome, start writing in a document, and watch the extension capture writer actions in your terminal.

• To load the Chrome extension, go to chrome://extensions/ in your Chrome browser. Make sure Developer mode is toggled on in the upper right corner. In the upper left, select Load unpacked. This will bring up a directory listing. Select the folder called extension inside your REWARD directory.
• Once you have loaded the extension from your directory, you can use it. Open a document in Overleaf, then click the extensions button in the upper right corner of your Chrome browser (the button looks like a puzzle piece). Choose ReWARD from the drop down list. Once you have selected the extension, changes you make to the document will be logged in the terminal you are running the server from.

Contributors

(* indicates the main student leads of the project) [To be updated]