Skip to content

Latest commit

 

History

History
144 lines (96 loc) · 4.39 KB

README.md

File metadata and controls

144 lines (96 loc) · 4.39 KB
Raw

GitHub code size in bytes GitHub issues Languages

Honourable Mention @ WaffleHacks 2023 🧇

Table of Contents

- Introduction 
- Problem it solves
- Tech Stack
- Screengrabs
- Scalability
- Setup Guide
- Contribution Guidelines
- License

💙 Introduction

NOISA

NOISA stands for No Invasive Site Animations. It is a browser extension developed for people with photosensitive epilepsy and vestibular disorders, for making web surfing accessible and inclusive!

What are Vestibular Disorders?

Any disease, damage, or injury to the vestibular system—the system around our inner ear and brain that processes sensory information involved in controlling balance and eye movements—falls under the umbrella of a vestibular disorder.

💡 Problem it solves

Websites contain potential triggering animations and features for people suffering from vestibular disorders. With a purposeful regulation over motions and animations, the user takes control of how to render the content, making web surfing more accessible.

A user will have control over the following aspects:

image

📍 Tech Stack

JavaScript

📷 Screengrabs

Before NOISA Activation After NOISA Activation
image image

🌺 Scalability

The project can be scaled to fulfill huge possibilities. The current scalable paths comprise of :

Reader Mode

  • Zoom in/out
  • Generous line spacing / leading.
  • Avoiding contrast and small font size.

Aspect Ratio

  • A screen size ranging between 19 and 22 inches is helpful for a person with a vestibular disorder who writes and edits documents.

🔨 Setup Guide

To start with setting up the Local Project Environment:

git clone https://github.com/chinmaychahar/NOISA.git

Navigate to chrome://extensions/

Toggle the developer mode on.

Click on 'Load Unpacked'

Select the complete cloned folder and get started.

🤝 Contribution Guidelines

Kindly follow the below guidelines if you wish to contribute to the project:

  1. Fork this repository and clone it
git clone https://github.com/chinmaychahar/NOISA.git
  1. Add a reference(remote) to the original repository
git remote add upstream https://github.com/chinmaychahar/NOISA.git
  1. Check the remotes for this repository
git remote -v
  1. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository)
git pull upstream main
  1. Create a new branch
git checkout -b <your_branch_name>
  1. Perfom desired changes to the code base and track your changes
git add .
git status
  1. Commit your changes
git commit -m "Relevant message"
  1. Push the committed changes in your feature branch to your remote repo
git push -u origin <your_branch_name>

  1. To create a pull request, click on compare and pull requests

  2. Add appropriate title and description to your pull request explaining your changes. Click on Create Pull Request

📜 License

MIT License