Development Guide

Prerequisites

• Basic web scraping knowledge with Javascript
• Basic knowledge with HTML & CSS (If you're planning to contribute on UI designing too)
• Basic understanding of Chrome API
• Familiar with chrome extension development --- manifest v3. Official Google Tutorial

Getting Started

Note: This guide is based on Google Chrome workflow, so some of the steps (especially manifest.json format) may not directly apply to other browsers. Please refer to the respective browser's documentation for more information.

Start Implementing

1. Clone the Repository

   git clone https://github.com/FramedStone/SassyNic.git
   

2. Understand SassyNic

   • Extraction
   • Pruning
   • Displaying

3. Understand Algorithm(s) used by SassyNic (optional: Only if you're implementing algorithm(s) related stuffs)

   • Backtracking
   • Genetic (Only fitness function(s) are being applied)

4. Load, Test, Document and Create PR (Pull Request)

   • Open Chrome browser and go to chrome://extensions/
   • Enable Developer mode (toggle switch at the top right)
   • Click on Load unpacked and select the cloned repository
   • Test the implemented version
   • Make proper Documentation and create a Pull Request by following PULL_REQUEST_TEMPLATE