pcrain / review-reappropriator

Proof-of-Concept for a design feedback reappropriation system (for CS 510 @ UIUC, fall 2018)

Dependencies:

• PHP (tested with 7.2.13), with sockets enabled
• Python (tested with 3.6.0 and 3.7.1):
  • sortedcontainers - for various indexed data structures with low memory overhead (tested with 2.0.5)
    • http://www.grantjenks.com/docs/sortedcontainers/
  • spacy - for part of speech tagging and various NLP operations (tested with 2.0.12)
    • https://spacy.io/
    • Also need the "en_core_web_sm" data set: https://spacy.io/models/en
  • nltk - for ngram extraction and various NLP operations (tested with 3.3)
    • https://www.nltk.org/
  • jsonstreamer - for reading in, parsing, and working with large JSON files (tested with 1.3.6)
    • https://github.com/kashifrazzaqui/json-streamer
• Node.js (tested with 11.3.0) (only needed if you want to run the review scraper yourself)
  • google-play-scraper - for downloading review / app data from the Google Play Store (tested with 6.1.0)
    • https://github.com/facundoolano/google-play-scraper

One Time Steps:

• Make sure all of the dependenices listed above are installed
• Clone this project from GitHub
• Download all the files from the following link and put them in the "data" subdirectory: https://app.box.com/s/dyt062sr3yq8p7xp1if3na9m2vpbpm35
  • These files may be generated manually, but will take a very long time; downloading is recommmended

Launching the Server:

• Run ./_launch_server in an open terminal window
  • Alternately, start the server manually by running php -S 127.0.0.1:8888 in the project directory
• In another terminal, run ./0-pipeline
  • If you are using the files downloaded above, the script may be run as is
  • Otherwise, uncomment all commented commands in the file first before running (they may be safely commented out again after running the first time)
• Wait for the program data to load into memory. This will take about 15-30 minutes depending on your machine.
• The server is ready once you see "Listening on '127.0.0.1'"

Using the Client:

• Once the server is running, open 6-ui-prototype.html in a web browser
• That's it! You may enter feedback in the text area, and hit enter or click "search" to receive feedback, phrasing, and topic suggestions. You may hover over phrasing suggestions (bold) to highlight the corresponding snippets between the input feedback and the returned feedback.