Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/konsalex/storybook-vite-react-context
Reproduce a react context weird issue with Storybook
https://github.com/konsalex/storybook-vite-react-context
Last synced: 24 days ago
JSON representation
Reproduce a react context weird issue with Storybook
- Host: GitHub
- URL: https://github.com/konsalex/storybook-vite-react-context
- Owner: konsalex
- Created: 2022-11-11T11:08:07.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-11T11:28:29.000Z (about 2 years ago)
- Last Synced: 2024-10-30T09:28:12.095Z (2 months ago)
- Language: TypeScript
- Size: 4.79 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Building a company design system 🎨
Learn the foundational concepts necessary for building
a complete engineering design system from scratch
## Quick start
Assuming that you will run in a local development environment, follow the instructions below:
#### 1. Install `yarn`
This repository uses `yarn` v3 (berry).
#### 2. Install the packages
Run `yarn` to install the node packages
### 3. Build the packages
Some packages need to be built before consuming them, like the `foundation`, which will distribute the design tokens to the rest of the packages. To build the packages execute:
```bash
yarn workspace @newline-ds/foundation build # Build the foundation package
yarn workspace @newline-ds/react build # Build the react package
```
## System Requirements
- git
- NodeJS `>=10.13.0` to work with Storybook
- yarn v3
## Run Storybook
You can run Storybook and instantly start experimenting with the components' code running the command:
```bash
yarn workspace @newline-ds/storybook storybook
```
A compiled storybook can be found also [here](https://design-system-newline.surge.sh/).
## Prerequisites
- Knowledge of JavaScript
- Basic knowledge of TypeScript would be helpful
- This repository uses React, but you can swap it with your own framework of choice
## Code Feedback
If you spotted a bug 🐛 or an incompatibility with newer versions please feel free to open an issue or a pull request.