Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chepetime/react-design-system
UI Component Library Template with React, Typescript, Storybook, SASS, Rollup and NextJs.
https://github.com/chepetime/react-design-system
component-library nextjs react react18 storybook template turborepo typescript ui-kit
Last synced: 4 days ago
JSON representation
UI Component Library Template with React, Typescript, Storybook, SASS, Rollup and NextJs.
- Host: GitHub
- URL: https://github.com/chepetime/react-design-system
- Owner: chepetime
- Created: 2022-08-04T01:15:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-31T17:37:09.000Z (9 months ago)
- Last Synced: 2024-03-31T18:35:30.042Z (9 months ago)
- Topics: component-library, nextjs, react, react18, storybook, template, turborepo, typescript, ui-kit
- Language: TypeScript
- Homepage: https://ui.joselugo.dev
- Size: 8.26 MB
- Stars: 39
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
React Design System
Component Library for a Design System using React and Turborepo
[](https://github.com/chepetime/react-turborepo-dls/actions/workflows/ci.yml) [](https://github.com/chepetime/react-turborepo-dls/actions/workflows/storybook-tests.yml) [](https://github.com/chepetime/react-design-system/actions/workflows/deploy-docs.yml)
[](https://main--640570a127fec98c46084e16.chromatic.com/)
## Structure
This monorepo contains multiple projects that work together to create an integrated Design Language System.
### Packages
> Packages are reusable libraries available for packages and apps
| Package directory | Description |
| ----------------- | -------------------------------------------------------------- |
| `packages/ui` | React based component library with Typescript, Rollup and SASS |
| `packages/tokens` | Design Tokens distributable package |
| `packages/icons` | React based icon library with SVGR and Rollup |
### Apps
> Apps can use all the available packages
| App directory | Description |
| ------------- | ------------------------------------------------------ |
| `apps/docs` | Storybok instance that implements the React UI Library |
| `apps/web` | React web app that implements the React UI Library |
### Config
> Config are reusable eslint and typescript configurations
| Package directory | Description |
| ----------------------------- | ------------------------------------------------ |
| `config/eslint-config-custom` | Shared Eslint configuration for all packages |
| `config/tsconfig` | Shared Typescript configuration for all packages |
### Tools
> Tools to generate Components or get Tokens
| App directory | Description |
| ----------------- | --------------------------------------------------------- |
| `tools/generator` | CLI Tool that creates Components for the React UI Library |
## Development
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Make sure you have the LTS version of [Node](https://nodejs.dev/) (18.7) installed in your machine. We recommend to use [nvm (Node Version Manager)](https://github.com/nvm-sh/nvm).
This monorepository uses Turborepo to manage dependencies and scripts. The first step is to install the local node dependencies:
```sh
pnpm install
```
There are two main ways to develop new components:
- Storybook App (Vite)
- Watch the React UI Library (Rollup) + NextJs
### Development Storybook
To watch changes in the React Library and start the Storybook App, just run:
```sh
pnpm run storybook
```
> This instance of Storybook uses the source code to compile the React Stories. It's faster than watching changes and reloading and it gets HMR. That's the reason components are imported using `@chepe/ui/src` instead of `@chepe/ui`.
### Development NextJs
To watch changes in the React Library and start the Next.Js App, just run:
```sh
pnpm run web
```
> Contrary to the Storybook instance, this React App uses the bundled code inside React. It should be really similar to the final package being used by product teams.
## Continuous Integration
This project has multiple GitHub Actions for build, test and deployment.
You can finds all the GitHub actions files inside `.github/workflows/`
| Name | File | Description |
| --------------- | --------------------- | ----------------------------------------------------------------------- |
| Build | `ci.yml` | Builds the main Component Library. (@chepe/ui) |
| Storybook Tests | `storybook-tests.yml` | Turns all the Storybook _stories_ into executable tests including a11y. |
## Tools
### Add a new Component
You can add a new Component Boilerplate using the Generator Tool.
```sh
npm run generate:component --name=Heading
npm run generate:component --name=InputField
```
## Built With
- [React@18](https://reactjs.org/)
- [Rollup](https://rollupjs.org/)
- [Storybook](https://storybook.js.org/)
- [Turborepo](https://turborepo.org/)
---
Made by [@chepetime](https://github.com/chepetimetime) at Mexico City 🇲🇽