Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 2.55 KB

File metadata and controls

79 lines (52 loc) · 2.55 KB

fall23eecs495-ai-reading-assistant

Welcome!

This is an open source project building off work started by the team for the capstone class EECS 495: Software for Accessibility at the University of Michigan. Please contact 495-ai-reading-assistant@umich.edu via email if there are any questions/issues regarding the instructions below!

Demo Video of Extension

beta_release_demo.mp4

User Interface of "SARA: Supportive AI Reading Assistant"

The pictures below show our extension in action:
extension1 extension2 extension3

Chrome Extension Setup

  1. Clone the GitHub repository to your local machine
git@github.com:dasanchez981/fall23eecs495-ai-reading-assistant.git
  1. Ensure that NodeJS is installed on your local machine. Go here for download instructions.

  2. To ensure that Node Package Manager is successfully installed on your machine execute this command. This should return a version.

npm -v
  1. Fill in the API credentials provided in the .env.tpl file located in the ai-reading-assistant folder
cd ai-reading-assistant
  1. Rename the template env (.env.tpl) to .env for use in the extension
mv .env.tpl .env
  1. Navigate to the /ai-reading-assistant folder and install the needed node modules
cd ai-reading-assistant
npm install
  1. Build the extension locally by running the following command:
npm run build
  1. Ensure that a 'dist' folder exists at ai-reading-assistant/dist, this will be loaded into the browser

  2. Go to your Chrome Web Browser and navigate to chrome://extensions

step4

  1. Toggle "Developer mode" ON in top right hand corner of page

  2. Click "Load unpacked" button in top left hand corner of page

step5-6

  1. Select the "dist" folder at /ai-reading-assistant/dist in the repository

  2. Now you should see "AI-Reading-Assistant" as one of your extensions

  3. Click on puzzle piece in the top right hand corner of browser window and pin the extension

step9

  1. Click on the 'SidePanel' icon at the top right of your browser toolbar

step10

  1. Click on the 'SidePanel' dropdown and select the extension

step11

  1. Now the extension should be loaded into your browser. Enjoy!