chinmaychahar / safeweb Goto Github PK

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

SafeWeb is a browser extension that aims to promote healthy computer habits by helping users build the habit of following the 20-20-20 rule. With its customizable settings and user-friendly design, SafeWeb is a great addition to any computer user's toolkit.

I developed SafeWeb because I realize the negative effects of prolonged computer use on my vision and overall health. Studies have shown that regularly taking short breaks can reduce the risk of developing computer vision syndrome, which can lead to dry eyes, headaches, and blurred vision. [Reference Study]

However, I found it challenging to remember to take these breaks regularly. That's why I created SafeWeb, a browser extension that displays a friendly reminder after 20 minutes of continuous computer use, encouraging users to take a 20-second break and look at an object 20 feet away. With SafeWeb, I am able to take care of my health while still being productive on my computer.

Toggle Popup of the Extension	Main Tab

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

• Multi-language support: SafeWeb currently supports one language, but adding support for multiple languages could expand its reach to a wider audience, especially those who do not speak the language currently supported.

• Gamification: Adding game-like features, such as points, badges, and leaderboards, could encourage users to take regular breaks and follow the 20-20-20 rule. This would make the experience more engaging and potentially increase user retention.

• Analytics: Collecting usage data and analyzing it could provide insights into user behavior and help improve the effectiveness of SafeWeb. This could also be useful for identifying user pain points and improving the user experience.

• Accessibility features: SafeWeb could be designed with accessibility features, such as text-to-speech and screen reader support, to make it more accessible to users with disabilities.

To start with setting up the Local Project Environment:

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

Navigate to chrome://extensions/

Toggle the developer mode on.

Click on 'Load Unpacked'

Select the complete cloned folder and get started.

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/SafeWeb.git

2. Add a reference(remote) to the original repository

git remote add upstream https://github.com/chinmaychahar/SafeWeb.git

3. Check the remotes for this repository

git remote -v

4. 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

5. Create a new branch

git checkout -b <your_branch_name>

6. Perfom desired changes to the code base and track your changes

git add .
git status

7. Commit your changes

git commit -m "Relevant message"

8. Push the committed changes in your feature branch to your remote repo

git push -u origin <your_branch_name>

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

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

GNU General Public License v3.0