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 [email protected] via email if there are any questions/issues regarding the instructions below!
beta_release_demo.mp4
The pictures below show our extension in action:
- Clone the GitHub repository to your local machine
[email protected]:dasanchez981/fall23eecs495-ai-reading-assistant.git-
Ensure that NodeJS is installed on your local machine. Go here for download instructions.
-
To ensure that Node Package Manager is successfully installed on your machine execute this command. This should return a version.
npm -v- Fill in the API credentials provided in the .env.tpl file located in the ai-reading-assistant folder
cd ai-reading-assistant- Rename the template env (.env.tpl) to .env for use in the extension
mv .env.tpl .env- Navigate to the /ai-reading-assistant folder and install the needed node modules
cd ai-reading-assistant
npm install- Build the extension locally by running the following command:
npm run build-
Ensure that a 'dist' folder exists at ai-reading-assistant/dist, this will be loaded into the browser
-
Go to your Chrome Web Browser and navigate to chrome://extensions
-
Toggle "Developer mode" ON in top right hand corner of page
-
Click "Load unpacked" button in top left hand corner of page
-
Select the "dist" folder at /ai-reading-assistant/dist in the repository
-
Now you should see "AI-Reading-Assistant" as one of your extensions
-
Click on puzzle piece in the top right hand corner of browser window and pin the extension
- Click on the 'SidePanel' icon at the top right of your browser toolbar
- Click on the 'SidePanel' dropdown and select the extension
- Now the extension should be loaded into your browser. Enjoy!