https://github.com/coinbase/cb-cookie-manager
Packages for managing first party client side cookies following GDPR regulations
https://github.com/coinbase/cb-cookie-manager
Last synced: about 1 year ago
JSON representation
Packages for managing first party client side cookies following GDPR regulations
- Host: GitHub
- URL: https://github.com/coinbase/cb-cookie-manager
- Owner: coinbase
- License: other
- Created: 2023-12-05T16:48:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-20T15:55:35.000Z (over 1 year ago)
- Last Synced: 2025-03-24T10:38:43.271Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 3.41 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Coinbase Cookie Manager
**Coinbase Cookie Manager is a lightweight package for first-party client side cookies that helps adhere to CCPA and GDPR cookie regulations**
# Contents
- [Introduction](#introduction)
- [Getting Started](#GettingStarted)
- [Packages](#packages)
- [Contributing](#contributing)
- [License](#License)
## Introduction
It can manage four different types of first-party client side cookies:
- `Necessary Cookies`: Cookies that are necessary for the site to function
- `Performance Cookies`: Cookies that impact site performance and help mesaure performance
- `Functional Cookies`: Cookies to improve the functionality of the site
- `Targeting Cookies`: Cookies used for advertising and ad targeting
## Getting Started
This repo uses a yarn workspace. To get started with the example app:
```shell
cd /path/to/coinbase/cb-cookie-manager
# Install Dependencies and Build Packages
yarn install
yarn build
# Run Example App
cd /path/to/coinbase/cb-cookie-manager/example/app
yarn dev
```
## Testing
yarn test
## Packages
- `@coinbase/cookie-manager`: Package that helps with managing first party client side cookies to adhere to CCPA and GDPR Cookie regulations. More information [here](./packages/cookie-manager/README.md)
- `@coinbase/cookie-banner`: Banner and modal to allow users to choose their cookie preferences.
More information [here](./packages/cookie-banner/README.md)
- `example`: Example app built using NextJS which uses both `@coinbase/cookie-manager` and `@coinbase/cookie-banner`. Code [here](./apps/example/)
## Contributing
Commit signing is required for contributing to this repo.
For details, see the docs on [contributing](./CONTRIBUTING.md) and [commit-signing](./docs/commit-signing.md).
## License
Licensed under the Apache License. See [LICENSE](./LICENSE) for more information.