@thairath/tr-design-system
v0.2.23
Published
This repository contains the Design System for [Your Project/Organization], built with [React + Storybook]. It follows the **Atomic Design Methodology** to ensure consistency and reusability across the UI.
Keywords
Readme
📚 Design System Storybook
This repository contains the Design System for [Your Project/Organization], built with [React + Storybook].
It follows the Atomic Design Methodology to ensure consistency and reusability across the UI.
🚀 Getting Started
1. Install dependencies
npm install
# or
yarn install2. Run Storybook
npm run storybook
# or
yarn storybookOpen your browser and go to: http://localhost:6006
🧱 Structure
This Design System follows Atomic Design principles:
src/
└── components/
├── atoms/
├── molecules/
├── organisms/
└── templates/Each component is:
- Documented in Storybook
- Themed using [e.g., Tailwind, styled-components, etc.]
- Tested (optional)
🧩 Technologies Used
- React
- Storybook
- [TypeScript] (optional)
- [Tailwind CSS / Styled-Components] (optional)
- [Figma Tokens] (if connected)
- [Jest / Testing Library] (if added)
🛠 Scripts
| Command | Description |
|-----------------------------|--------------------------------------|
| npm run storybook | Start Storybook locally |
| npm run build-storybook | Build Storybook as a static site |
| npm run lint | Run linter for code quality check |
| npm run format | Format code using Prettier |
| npm test | Run tests (if configured) |
📦 Build for Deployment
To build the static version of Storybook:
npm run build-storybookThe static files will be output in the storybook-static/ directory. You can deploy it to platforms like Vercel, Netlify, or host it internally.
