Skip to content

The reVision extension allows a JSON object from the reVision Socket Server to be received and saved in local storage. This extension's instructions are for Google Chrome; however, the extension also works in Mozilla Firefox, Microsoft Edge, Brave, and Opera.

License

Notifications You must be signed in to change notification settings

iflinda/NW-Plus-Extension

 
 

Repository files navigation

reVision Extension

Example

This is a Chrome extension that was built to work seamlessly with the reVision Socket Server by accepting a JSON object that has an ID (roomId) and text content (content). This extension sets the Id and text to local storage, and the extension will pull the data that already exists. If none is available, the user can generate their ID to use.

reVision Application

The reVision application has four major components that allow the application to work seamlessly together.

  • Front-end Application

    • https://github.com/jdhanju/nwhacks-2022-app
    • The Front-end Application allows the user to upload their photo where it is then sent to the Processing API to be converted to text.
    • Technologies: React, Next.js, Tailwind CSS, ESLint, and Prettier
  • Processing API

    • https://github.com/jsam07/text-recognition-api
    • The Processing API is an OCR & HCR based API that transcribes an image to text using a combination of Microsoft Cognitive Services and Google's Cloud Vision API. The text is sent back to the front-end application after processing.
    • Technologies: JavaScript (ES6), TypeScript, Docker, Microsoft Cognitive Services, Google's Cloud Vision API, ESLint, and Prettier
  • Socket Server

    • https://github.com/matteomiceli/nwHacksSocketServer
    • The Socket Server facilitates communication between the front-end application and the extension. It accepts an object from the front-end application that contains the ID (roomId) and text (content) and sends that information to the browser extension.
    • Technologies: JavaScript (ES6), Socket.io, ESLint, Prettier
  • Browser Extension

    • https://github.com/iflinda/nwPlusExtension
    • The Browser Extension listens to the Socket Server and accepts an object that contains the ID (roomId) and text (content). After receiving an ID match, the content is shown as text in the extension; thus, allowing for users to copy and paste the text.
    • Technologies: React, TypeScript, Webpack.js, Tailwind CSS, ESLint, and Prettier

Important Acknowledgements

Please note that this web extension was created via the starter template available at: https://github.com/BCIT-DDC/web-extension-ts-starter created by Jamie Samuel (https://github.com/jsam07). No existing logic was used to create this extension.

Instructions

1. Clone the Repository.

git clone https://github.com/iflinda/nwPlusExtension.git

2. Open the folder from the terminal.

cd nwPlusExtension

3. Install any dependencies.

npm install

4. Build the production environment.

npm run build

5. Open your Chrome browser and go to chrome://extensions

Example2

6. Click on Load unpacked

Example3

7. Open the dist folder inside of the project folder (nwPlusExtension).

Example4

8. The reVision extension is now available for use!

Example5

Team

Built With

  • React
  • TypeScript
  • Webpack
  • TailwindCSS

About

The reVision extension allows a JSON object from the reVision Socket Server to be received and saved in local storage. This extension's instructions are for Google Chrome; however, the extension also works in Mozilla Firefox, Microsoft Edge, Brave, and Opera.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 68.1%
  • JavaScript 28.1%
  • HTML 2.2%
  • CSS 1.6%