README.md

blindnet devkit
Privacy Components for the web

Collection of Web Components helping developers to execute privacy-by-design and privacy UX.

blindnet.dev

Submit an Issue  •  Online Chat

Components

The Privacy Components for the web are implemented as a collection of web components, with associated npm packages.

Component	Npm Package	Purpose
<bldn-priv-request>	@blindnet/priv-request	Make privacy requests
🚧 👷	and more soon...

Installation

Use npm or yarn to install the component you need:

npm i @blindnet/<component-name>

For example:

npm i @blindnet/priv-request

Usage

To use a component, simply import the associated package, and add the associated custom element to your document:

<script type="module">
  import '@blindnet/<package-name>';
</script>

<bldn-selector></bldn-selector>

For example, when using the priv-request component:

<script type="module">
  import '@blindnet/priv-request/bldn-priv-request.js';
</script>

<bldn-priv-request></bldn-priv-request>

Community

All community participation is subject to blindnet’s Code of Conduct.

Stay up to date with new releases and projects, learn more about how to protect your privacy and that of our users, and share projects and feedback with our team.

• Join our Slack Workspace to chat with the blindnet community and team
• Follow us on Twitter to stay up to date with the latest news
• Check out our Openness Framework and Product Management on Github to see how we operate and give us feedback.

Contributing

This collection of web components follows the open-wc recommendation.

Contributions of all kinds are always welcome!

If you see a bug or room for improvement in this project in particular, please open an issue or directly fork this repository to submit a Pull Request.

If you have any broader questions or suggestions, just open a simple informal DevRel Request, and we'll make sure to quickly find the best solution for you.

Linting and formatting

To scan the project for linting and formatting errors, run

npm run lint

To automatically fix linting and formatting errors, run

npm run format

Localization

To generate translation files for each locale in /xliff, run

npm run localize

Testing with Web Test Runner

To execute a single test run:

npm run test

To run the tests in interactive watch mode run:

npm run test:watch

Demoing with Storybook

To run a local instance of Storybook for your component, run

npm run storybook

To build a production version of Storybook, run

npm run storybook:build

Tooling configs

For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

License

The blindnet devkit Privacy Components for the Web project is available under MIT (and here is why).