Hansel 🍪

Your Favorite Persona Extension

Table of Contents

1. Introduction
2. Prerequisites
3. Setting Up Web-Crawling
   • Installing Packages
   • Running the API
4. Building the Chrome Extension
   • Building the Extension
   • Loading the Extension in Chrome
5. Usage
6. Troubleshooting
7. Contributing
8. License

Introduction

Hansel 🍪 is a Chrome extension designed to fool web trackers based on user-created personas. This guide will help you set up and run the extension on your local machine.

Prerequisites

Before you begin, ensure you have the following installed on your machine:

• Python 3.8 or higher
• pip (Python package installer)
• Flutter SDK
• Google Chrome browser

Setting Up Web-Crawling

To set up the web-crawling component of the project, follow these steps:

Installing Packages

1. Open your terminal or command prompt.
2. Navigate to the web-crawling directory:

   cd web-crawling

3. Install the required packages using pip:

   pip install -r requirements.txt
   

Running the API

1. Start the API server using uvicorn:

   uvicorn main:app --reload

2. Your local host is now running and ready to accept requests from the web extension.

Building the Chrome Extension

To build and load the Chrome extension, follow these steps:

Building the Extension

1. Navigate to the ui directory:

   cd ui

2. Build the extension using Flutter:

   flutter build web --web-renderer html --csp
   

Loading the Extension in Chrome

1. Open Google Chrome and navigate to chrome://extensions.
2. Enable Developer mode by toggling the switch in the top right corner.
3. Click on the Load unpacked button.
4. Select the build directory within the ui directory.

Usage

Once the extension is loaded in Chrome, you can start using it by clicking on the extension icon in your browser. Follow the on-screen instructions to begin fooling web-trackers.

Troubleshooting

If you encounter any issues during the setup or usage of the extension, refer to the following steps:

• Ensure all dependencies are installed correctly.
• Check the terminal or command prompt for error messages.
• Restart the API server and reload the extension in Chrome.

Contributing

We welcome contributions to enhance the functionality and performance of Hansel 🍪. If you would like to contribute, please fork the repository, create a new branch, and submit a pull request with your changes.

License

This project is licensed under the MIT License.

---

Feel free to reach out if you have any questions or need further assistance. Enjoy your free cookie 🍪!