Overview:
This monorepo contains multiple projects that work together to create an integrated Design Language System. It includes reusable component libraries, design token packages, icon libraries, and apps that utilize these packages. It also provides reusable eslint and typescript configurations, as well as tools for generating components and getting tokens. The project can be set up and run locally for development and testing purposes.
Features:
- Reusable Packages: Packages including a React-based component library, design token distributable package, and a React-based icon library.
- App Integration: Apps that can use all the available packages, including a Storybook instance that implements the React UI Library and a React web app that implements the React UI Library.
- Configurations: Reusable eslint and typescript configurations.
- Component Generation: A CLI tool that creates components for the React UI Library.
Installation:
- Make sure you have the LTS version of Node (18.7) installed on your local machine.
- Install nvm (Node Version Manager) for easier management of Node versions.
- Install the local node dependencies by running the following command:
npm install
Summary:
This monorepo provides a comprehensive Design Language System through reusable packages, app integration, configurations, and tools for component generation. It allows for efficient development and testing, with options for watching changes in the React Library either through Storybook or Next.js. The project also includes GitHub Actions for build, test, and deployment automation.