README.md

Watson-TA

• What is Watson TA
• Setup
  • Watson TA Docker
• The Team

What is Watson TA

We plan on making the Watson TA. It will be a web app where students can upload a school assignment (homework, quiz, test, etc.) and help the student complete the assignment. The app will provide a structured interface for answer exploration and completion providing structured parsing, drag and drop answer composition, etc. Culminating in the students ability to export the finished assignment for submission.

Don't want to download the app? View the final UI and feature documentation here in slide form.

Setup

Watson TA Docker

1. Clone and cd into the watson-ta repository (e.g. pwd should end in watson-ta/)
2. Add the API keys to a .keys.sh file (placed in watson-ta/)

## The keys required for Watson-TA
# NLC
export watson_username=''
export watson_password=''

# Alchemy
export watson_alchemy_key=''

# Retrieve and Rank
export watson_rr_username=''
export watson_rr_password=''
export watson_rr_cluster_id=''

# Document Conversion
export watson_dc_username=''
export watson_dc_password=''

# Github
export github_username=''
export github_password=''

3. Build the container by running:

# Builds a container named "watson-ta" from the Dockerfile at . (e.g. the current directory)
docker build -t watson-ta .

4. Enter the container by running:

# Mounting the watson-ta local repo & keys to enable active development
# Map the docker port `0.0.0.0:8000` to local port `127.0.0.1:8000`
# Enter an interactive terminal session of bash on the container
docker run -it --rm -v `pwd`:/app/ -p 127.0.0.1:8000:8000 watson-ta /bin/bash

5. You should now be within the watson-ta docker container!
6. Run the alias up to setup remaining configuration and boot the django server. The up command does the following:

# Notice: These are bash aliases defined in the .docker-setup.sh :)
# Run all within: /app/www/
# What up runs for you:
keys       # Load the keys
csu        # Create superusers
           #   username:   admin
           #   password:   watsonta
           #   email:      [email protected]
webpack    # Execute webpack using the `webpack.config.js`
serve      # Execute the alias serve

7. Navigate to localhost:8000 in a browser to interact with Watson TA application
8. The login is the following:

username = "admin"
password = "watsonta"
email    = "[email protected]"

9. Develop away with hot reload!
10. If you need to recompile the JavaScript use rb to rebuild the JavaScript and rerun the server

Testing

Run unit tests with pytest in the root /app directory within Docker:

root@d8f3d21c1533:/app# pytest
================================================ test session starts =================================================
[ . . . ]
============================================== n passed in 1.23 seconds ==============================================

Travis Continuous Integration will also run the testing suite on all commits and pull requests!

The Team

Team: Sign of the Horns (aka 🤘)

Dalton Flanagan	Liv Stanley	Bill Varcho	Tyler Zeller	David Soller
github.com/dltn	github.com/livstanley29	github.com/Varcho	github.com/tylermzeller	github.com/3ygun