https://github.com/justintemps/designsytem-poc
https://github.com/justintemps/designsytem-poc
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/justintemps/designsytem-poc
- Owner: justintemps
- Created: 2021-11-12T09:50:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-14T15:50:51.000Z (over 3 years ago)
- Last Synced: 2025-04-23T23:52:49.992Z (about 1 month ago)
- Language: SCSS
- Size: 6.13 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# UN Core-based Design System POC
[](https://lerna.js.org/)
This project is meant to illustrate how to create a design system using [UN Core](https://github.com/un-core/designsystem).
## Installation
Follow the [installation Instructions](./docs/installation.md) to get this project up and running. These include instructions for developing with a local version of UN Core.
## Packages
- [react](./packages/react)
- [styles](./packages/styles)
- [fonts](./packages/styles)
## Commands
Bootstrap project with latest version of [UN Core from npm](https://www.npmjs.com/search?q=%40un).
```bash
yarn bootstrap
```
Bootstrap project with a local version of UN Core (see [installation instructions](./docs/installation.md)).
```bash
yarn bootstrap:dev
```
Clean dependencies from all packages.
```bash
yarn clean
```
## Architecture
The project is a monorepo which separates the different aspects and implementations of the design system into different packages. This architecture mirrors that of UN Core and allows packages to share dependencies and functionality.
For example, both the `react` package and the `twig` package would both have a dependency on the same `style` and `fonts` packages. Updating styles for the `react` package would also update styles in the `twig` package. (Note: only examples for a `react` and `twig` package are provided here).
At the same time, this allows consumers to pick and choose the packages that they need. A project that doesn't use `react` or `twig` packages can still use the `style` and `fonts` package.