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.
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.
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.
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
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:
- Navigate to
chrome://extensions
- Enable the Developer Mode toggle in the top right corner
- Click "Load unpacked"
- Navigate to the extension build directory
cookie-engine/testExtension/crx