Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tracktor/design-system
Tracktor Design System
https://github.com/tracktor/design-system
design-system library material-ui react storybook
Last synced: 2 months ago
JSON representation
Tracktor Design System
- Host: GitHub
- URL: https://github.com/tracktor/design-system
- Owner: Tracktor
- License: isc
- Created: 2022-07-21T09:10:31.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-16T11:21:47.000Z (9 months ago)
- Last Synced: 2024-05-19T15:20:26.245Z (9 months ago)
- Topics: design-system, library, material-ui, react, storybook
- Language: TypeScript
- Homepage:
- Size: 2.93 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Tracktor design system
[](https://badge.fury.io/js/@tracktor%2Fdesign-system)
**A design system React library by [Tracktor](https://tracktor.fr/)**
> The library is based on [MUI Core](https://mui.com/material-ui/getting-started/overview/)
- [Installation](#Installation)
- [Usage](#Usage)
- [Provide the theme](#Provide-the-theme)
- [Package](#Package)
- [Docs](#Docs)
- [Contributing](#Contributing)
## Installation
**npm:**
```bash
npm install @tracktor/design-system
```
**bun:**
```bash
bun add @tracktor/design-system
```
**yarn**:
```bash
yarn add @tracktor/design-system
```
**pnpm**:
```bash
pnpm add @tracktor/design-system
```
## Usage
### Provide the theme
Put `` around your application.
Custom theme can be provided as prop `theme={YOUR_CUSTOM_THEME}`
```typescript jsx
import { Button, ThemeProvider } from "@tracktor/design-system";
const App = () => (
Text
);
export default App;
```
## Package
Package are available in `@tracktor/design-system/{package}`
| Package | Description |
|---------|-----------------------------------------------|
| colors | This package contains material design colors. |
## Docs
- [Material UI (MUI)](https://mui.com/material-ui/getting-started/overview)
- [Figma](https://www.figma.com/file/3fprVesPjVIo124UWy9xhU/MUI-for-Figma-Material-Pro-v5.9.0?node-id=4662%3A14)
- [Storybook](https://storybook.tracktor.fr/)
## Contributing
Read the [contributing guide](/CONTRIBUTING.md) to learn about our process.