@belastingdienst/bldc-components v4.0.0

What is the Belastingdienst Design System

The Belastingdienst Design System is the design system for the dutch government, made by designers, text writers and developers. It simplifies the creation of accessible products with a consistent user experience.

Our design system contains components, patterns, and guidelines for digital products, such as websites, forms, and applications.

Benefits

• Applicable throughout the national government organizations
• Complies with the government identity
• Meets levels A and AA of the WCAG requirements
• Extensive documentation with guidelines and examples
• Tested with users
• Easy to use
• Personal support
• Available in modern frameworks

What we offer

• Fundamentals: guidelines such as use of color, typography and the grid.
• Components: building blocks for digital products, such as websites, forms and (internal) applications.
• Patterns: generic patterns for common user problems, based on components.

Our design principles

Generic

It doesn't matter whether you are working on a website, portal, app or software, our design system can be used for everything.

Safe

Using a Shadow DOM ensures that websites and applications are more secure.

Recognizable

Simple components together form complex components. This way you see the same buttons, icons and headings.

Getting started

Setup

You'll need Git and Node.js installed to get this project running.

Note: You will need the active LTS (Long-term support) Node.js version for this project.

Using nvm (optional)

Working on multiple Node.js projects often means dealing with various versions of Node.js and npm specific to each project.

For seamless version management, we recommend using nvm (Node Version Manager), which allows for easy switching between Node.js versions.

Steps to follow: 1. Install nvm on your system. 2. In your project's root directory, execute nvm install to automatically select the correct Node.js version as specified in your project's .nvmrc file.

Clone repository

git clone git@github.com:belastingdienst/bldc-components.git # or clone your own fork

cd bldc-components

Run Local

Install npm dependencies

npm install

Build and Run

Build ./src to ./build

npm run build

Then run:

npm run start

You can now access the testpages on http://localhost:3333/. Any changes made to the components will rerender the localhost environment.

NPM Scripts

Dependencies

Security

The Dutch Tax and Customs Administration promotes the practice of responsible vulnerability disclosure. If you discover a vulnerability, we encourage you to report it to us so we can address it promptly.

For details on how to report a security vulnerability, please refer to our security policy.

License

Licensed under the EUPL 1.2.

Contributing

To learn how to help us build our Design System, see our contribution guidelines.

The bldc-components repository is an open source project. We believe in the power of collaboration and open source philosophy to improve government digital services. By sharing our Design System, we invite other agencies to benefit from our work and contribute back their improvements and innovations. This collaborative effort will enrich the system, making it more robust, versatile, and user-friendly.

Contributors to the bldc-components repository are expected to follow the Contributor Covenant Code of Conduct and to the Code of Conduct Integrity Central Government.