Overview

The BEEQ Design System is a collection of components implemented in a core library, as well as framework-specific wrappers for Angular and React. It offers a set of ready-to-use components that can be used in different technology stacks. The system is published to the NPM package manager registry, making it easy to integrate into projects. The BEEQ Design System also provides a component generator to quickly create new components. Overall, it aims to provide a streamlined and efficient way to develop and extend components within a design system.

Features

• Core library: A collection of elements/components implemented in the BEEQ Design System.
• Angular wrapper: A framework-specific wrapper for the BEEQ core library, specifically for Angular projects.
• React wrapper: A framework-specific wrapper for the BEEQ core library, specifically for ReactJS projects.
• Easy integration: The BEEQ components are published to the NPM package manager registry, making it simple to include them in projects.
• Extensive documentation: Detailed usage instructions and component APIs are provided, along with variations for each component.
• Multiple technology stack support: The BEEQ Design System currently supports Angular and React, with plans to add integration for Vue and Svelte in the future.
• Component generator: The BEEQ Design System includes a generator that automates the creation of new component skeletons.
• Testing support: BEEQ uses Jest for unit tests and Jest with Puppeteer for end-to-end tests, ensuring reliable and robust components.

Installation

To install the BEEQ Design System, follow these steps:

1. Ensure you have NodeJS v16.x or higher and NPM v8 or higher installed.
2. Optionally, use Volta to manage Node and NPM versions for seamless switching between projects.
3. Navigate to the BEEQ folder in your local project.
4. Run the following command to install the required dependencies:

npm install

Summary

The BEEQ Design System is a comprehensive collection of components implemented in a core library, with framework-specific wrappers for Angular and React. It offers easy integration with projects through NPM packages and provides extensive documentation for usage and component APIs. The BEEQ Design System supports multiple technology stacks and includes a component generator for efficient component creation. With testing support and a focus on streamlined development, the BEEQ Design System is a powerful tool for building design systems.