Skip to content

EduardoAC/site-review-extension

Repository files navigation

Chrome Extension: Site Reviewer

Overview:

The Site Reviewer Chrome Extension is a demonstration project designed to showcase testing strategies for Chrome extensions. It offers users the ability to rate and review websites directly within their Chrome browser. This extension aims to demonstrate best practices for testing Chrome extensions and highlights the importance of thorough testing in software development.

Features:

  1. Rating System: Users can rate websites based on their experience, providing valuable insights to other users.
  2. Review Submission: Write and submit reviews for websites, sharing personal experiences and opinions.
  3. Chrome Storage: Reviews are stored locally in Chrome storage cache, ensuring data privacy and security.
  4. Integration: Seamlessly integrates with the Chrome browser, appearing as an unobtrusive extension icon.
  5. Testing Strategies: Demonstrates various testing strategies for Chrome extensions, including unit tests, integration tests, and end-to-end tests.

Get Started:

  1. Clone Repository: Clone the Site Reviewer repository from GitHub.
  2. Install Dependencies: Run yarn install to install the required dependencies.
  3. Build Extension: Run yarn build to build the extension.
  4. Test Extension: Run yarn test to execute tests and ensure the extension functions correctly.
  5. Load Unpacked: Open Chrome browser and go to chrome://extensions/.
  6. Enable Developer Mode: Toggle the Developer mode switch on the top right corner.
  7. Load Extension: Click on "Load unpacked" and select the build directory of the extension.
  8. Ready to Use: Once installed, the extension is ready to use, and the icon will appear in the browser toolbar.

Usage:

  1. Rating: When visiting a website, click on the extension icon to rate and review the site.
  2. Submission: Submit your rating and review to contribute to the community feedback.
  3. Chrome Storage: Reviews are stored locally in Chrome storage cache, ensuring data privacy and security.

Testing Strategies:

  1. Unit Tests: Tests individual components and functions in isolation to ensure they work as expected.
  2. Integration Tests: Tests how different components interact with each other within the extension.
  3. End-to-End Tests: Tests the extension's functionality from the user's perspective, simulating real-world scenarios.

License:

The Site Reviewer extension is licensed under the MIT License. You are free to modify and distribute the extension according to the terms of the license.

About

Small demo chrome extension to review different sites and store within cache

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published