Code Monkey home page Code Monkey logo

cookie-cutter-engine's Introduction

Cookie Cutter Engine

This is the engine that powers Neeva's Cookie Cutter extension, available on the Chrome Web Store and Firefox Add-ons.

It's responsible for automatically answering GDPR, CCPA, and related cookie notices on the web according to user preferences.

Structure

This repository is split up into two parts:

  • ./engine: The engine, which handles detecting and handling cookie notices.
  • ./testExtension: A test Chrome extension which can be used to test changes made to the engine during development.

Contributing

If you'd like to contribute, awesome! Please take a look at the contributor guidelines first.

  • If you'd like to add support for a new provider, check out Adding a Provider
  • If you want to make changes to the general engine logic, check out Engine
  • If you're not sure what to contribute, take a look at the Issues page for ideas.

Building

The engine uses a standard NPM package.json. To build the code, first install the project:

$ yarn install

Then you can create a production build with:

$ yarn build

Or make a dev build and watch for changes with:

$ yarn watch

Testing

To test the engine, you can make use of the test extension in ./testExtension. It will automatically build and load the engine.

To install the test extension in Chrome, first build it:

cookie-engine/testExtension $ yarn install
cookie-engine/testExtension $ yarn build # or `yarn watch`

Then, in Chrome:

  1. Navigate to chrome://extensions
  2. Enable the Developer Mode toggle in the top right corner
  3. Click "Load unpacked"
  4. Navigate to the extension build directory cookie-engine/testExtension/crx

cookie-cutter-engine's People

Contributors

jlynch630 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.