-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: 📚 add README.md to each package (#524)
- Loading branch information
Showing
3 changed files
with
62 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# 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. | ||
|
||
## 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/components | ||
pnpm dev | ||
``` | ||
|
||
These steps will install the necessary dependencies, navigate to the "packages/components" directory, and start the development server. You can now take a look at our existing components or begin working on new ones. | ||
|
||
### Helpful Commands | ||
|
||
``` | ||
$ pnpm fix // fix all formatting and linting in repo | ||
$ pnpm verify // run tests and builds in repo | ||
$ cd packages/components | ||
&& pnpm dev // start dev server | ||
&& 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](CONTRIBUTING.md) 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](./packages/components/LICENSE.md) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Tokens | ||
|
||
The Solid Design System Tokens package provides a collection of design tokens for colors, typography and spacing. It ensures design consistency and collaboration between our designers and developers when building components for the Solid Design System. | ||
|
||
Check out the [full documentation](https://solid-design-system.fe.union-investment.de/x.x.x/storybook/) for detailed information. |