Skip to content

Latest commit

 

History

History
169 lines (113 loc) · 4.49 KB

README.md

File metadata and controls

169 lines (113 loc) · 4.49 KB
Raw

Sia

Sia is a browser extension that not only makes your browsing experience safe but makes it optimized

Table of Contents
  1. About The Project
  2. Getting Started
  3. API Setup
  4. API Usage
  5. Outputs
  6. Roadmap
  7. Contributing
  8. License

About The Project

The idea came to us from some previous projects about making a browser extension that could automate the stuff and make surfing an awesome experience. There are lot of people that get scammed everyday due to opening malicious links or get cyberbullied online and they don't that's actually happening. People with dyslexia can't read things on browsers properly or we don't want to really read a whole site to gain some information but would like it if were read to us. For all these problems and more Sia was built.

Built With

Getting Started

Follow the instructions to setup the project locally!

Installation

  1. Clone this repository.

    git clone https://github.com/arungovindm2001/Sia.git

  2. Open chrome://extensions within your Chrome browser.

  3. Enable Development Mode.

  4. Click on Load unpacked and select the cloned repository.

  5. Click on the extensions button next to your browser address bar and pin Sia.

API Setup

Prerequisites(Only if testing API)

Make sure to have virtualenv package from python installed before proceeding to installation.

pip install virtualenv

Installation

  1. Activate the virtual environment 
    cd Sia/PyTorch-NLP-API
virtualenv venv
. venv/bin/activate
  2. Install the required packages using pip 
    pip install -r requirements.txt
  3. Run the app 
    python app.py

API Usage

We have also built an API during the hackathon.

  1. Detect malicious URL
https://safe-api.azurewebsites.net/predict?url=https://www.google.com
  1. Detect toxic comment
https://safe-api.azurewebsites.net/predict/toxic?text="you are so dumb"
  1. Localhost
https://127.0.0.1/predict?url="https://www.google.com"
https://127.0.0.1/predict/toxic?text="you are so dumb"

Outputs

Help dyslexic people see content

img1

Convert browser text into American Sign Language

img2

Use Image Veil to hide images, magnify images or highlight words

img3

Change font color or magnify images

img4

Use Color blind mode to get color under the texts

img5

(View the video demo for more examples)

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.