Solid Design System Monorepo

Monorepo for Union Investment's Solid Design System.

Packages

1. Solid

The solid package contains all the components that make up the Solid Design System.

2. Placeholder

The placeholder package provides placeholder images that can be used alongside the Solid Design System components during development and prototyping.

3. Tokens

The tokens package contains all the design tokens used in the Solid Design System.

4. Theming The theming package provides a color calculation service for the Solid Design System.

5. Docs The docs package provides documentation for Solid Design System.

6. Eslint plugin The eslint-plugin package provides custom ESLint rules to the Solid Design System.

Quick Start

To get started with the code steps, follow these instructions:

We use pnpm package manager, so make sure to have it installed globally before you start.

• https://pnpm.io/installation

pnpm i
cd packages/docs
pnpm dev

These steps will install the necessary dependencies, navigate to the "packages/docs" directory, and start the development server. You can now take a look at our existing components or begin working on new ones.

[!TIP] If you are working on several projects, you can use Corepack to manage the pnpm version and n/nvm to manage the Node version for each project. This way, you can avoid version conflicts and ensure that you are using the correct version of pnpm for each project.

Helpful Commands

$ pnpm test          // run only tests in repo
$ pnpm fix           // fix all formatting and linting in repo
$ pnpm verify        // run tests and builds in repo
$ cd packages/docs
  && pnpm dev        // start dev server
  && pnpm test       // run accessibility tests
$ cd packages/components
  && pnpm test       // run tests
  && pnpm test.watch // run tests in watch mode
  && pnpm test.single [test-file-name] // run a specific test file
$ cd packages/eslint-plugin
  && pnpm test       // run tests

Contributing

We welcome contributions from the community! If you'd like to contribute to any of the packages or improve the Solid Design System, please follow our contribution guidelines provided in this repository.

License

This repository is licensed under MIT, except the fonts, icons and images, which are licensed under their respective licenses. Read the full license for more information.