sestek-component 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +101 -0
- package/package.json +90 -0
package/README.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# Sestek UI Components
|
|
2
|
+
|
|
3
|
+
A React component library built with TypeScript, Tailwind CSS, and Shadcn.
|
|
4
|
+
|
|
5
|
+
## Getting Started
|
|
6
|
+
|
|
7
|
+
### Prerequisites
|
|
8
|
+
|
|
9
|
+
- Node.js (v20 or higher recommended)
|
|
10
|
+
|
|
11
|
+
### Installation
|
|
12
|
+
|
|
13
|
+
1. Clone the repository:
|
|
14
|
+
```bash
|
|
15
|
+
git clone https://github.com/sestek/ui-component.git
|
|
16
|
+
cd ui-component
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
2. Install dependencies:
|
|
20
|
+
```bash
|
|
21
|
+
npm install
|
|
22
|
+
# or
|
|
23
|
+
yarn install
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Development
|
|
27
|
+
|
|
28
|
+
### Running Storybook
|
|
29
|
+
|
|
30
|
+
To start the Storybook development environment:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npm run storybook
|
|
34
|
+
# or
|
|
35
|
+
yarn storybook
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
This will start Storybook at [http://localhost:6006](http://localhost:6006)
|
|
39
|
+
|
|
40
|
+
### Available Scripts
|
|
41
|
+
|
|
42
|
+
- `npm run dev` - Starts the Vite development server
|
|
43
|
+
- `npm run build` - Builds the library for production
|
|
44
|
+
- `npm run lint` - Runs ESLint to check code quality
|
|
45
|
+
- `npm run preview` - Preview the production build locally
|
|
46
|
+
- `npm run storybook` - Starts Storybook development server
|
|
47
|
+
- `npm run build-storybook` - Builds Storybook for production
|
|
48
|
+
|
|
49
|
+
## Usage
|
|
50
|
+
|
|
51
|
+
### Installation in Your Project
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npm install sestek-ui-component
|
|
55
|
+
# or
|
|
56
|
+
yarn add sestek-ui-component
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Using Components
|
|
60
|
+
|
|
61
|
+
```jsx
|
|
62
|
+
import { Tab } from 'sestek-ui-component';
|
|
63
|
+
import 'sestek-ui-component/css';
|
|
64
|
+
|
|
65
|
+
function App() {
|
|
66
|
+
return (
|
|
67
|
+
<Tab />
|
|
68
|
+
);
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Features
|
|
73
|
+
|
|
74
|
+
- 🎨 Built with Tailwind CSS
|
|
75
|
+
- 🚀 Powered by Vite
|
|
76
|
+
- 📚 Documented with Storybook
|
|
77
|
+
- 🎯 Written in TypeScript
|
|
78
|
+
- âš¡ Optimized for production
|
|
79
|
+
|
|
80
|
+
## License
|
|
81
|
+
|
|
82
|
+
This project is licensed under the MIT License - see the LICENSE file for details
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
This README provides:
|
|
86
|
+
- An introduction to the project
|
|
87
|
+
- Installation instructions
|
|
88
|
+
- Development setup steps
|
|
89
|
+
- Available scripts and their purposes
|
|
90
|
+
- Usage examples
|
|
91
|
+
- Key features
|
|
92
|
+
- Contributing guidelines
|
|
93
|
+
- License information
|
|
94
|
+
|
|
95
|
+
You can customize this further by:
|
|
96
|
+
- Adding specific component documentation
|
|
97
|
+
- Including screenshots or GIFs of components
|
|
98
|
+
- Adding badges (build status, version, etc.)
|
|
99
|
+
- Including troubleshooting sections
|
|
100
|
+
- Adding more detailed usage examples
|
|
101
|
+
- Including links to additional documentation
|
package/package.json
ADDED
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "sestek-component",
|
|
3
|
+
"private": false,
|
|
4
|
+
"version": "0.0.1",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"scripts": {
|
|
7
|
+
"dev": "vite",
|
|
8
|
+
"build": "tsc -b && vite build",
|
|
9
|
+
"lint": "eslint .",
|
|
10
|
+
"preview": "vite preview",
|
|
11
|
+
"storybook": "storybook dev -p 6006",
|
|
12
|
+
"build-storybook": "storybook build",
|
|
13
|
+
"test": "vitest run",
|
|
14
|
+
"test:watch": "vitest",
|
|
15
|
+
"test:ui": "vitest --ui",
|
|
16
|
+
"test:coverage": "vitest run --coverage"
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"dist"
|
|
20
|
+
],
|
|
21
|
+
"sideEffects": [
|
|
22
|
+
"**/*.css"
|
|
23
|
+
],
|
|
24
|
+
"main": "./dist/index.cjs.js",
|
|
25
|
+
"module": "./dist/index.es.js",
|
|
26
|
+
"types": "./dist/index.es.d.ts",
|
|
27
|
+
"exports": {
|
|
28
|
+
".": {
|
|
29
|
+
"import": {
|
|
30
|
+
"types": "./dist/index.es.d.ts",
|
|
31
|
+
"default": "./dist/index.es.js"
|
|
32
|
+
},
|
|
33
|
+
"require": {
|
|
34
|
+
"types": "./dist/index.es.d.ts",
|
|
35
|
+
"default": "./dist/index.cjs.js"
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"./css": "./dist/style.css"
|
|
39
|
+
},
|
|
40
|
+
"peerDependencies": {
|
|
41
|
+
"react": "^19.0.0",
|
|
42
|
+
"react-dom": "^19.0.0"
|
|
43
|
+
},
|
|
44
|
+
"devDependencies": {
|
|
45
|
+
"@chromatic-com/storybook": "^3.2.5",
|
|
46
|
+
"@eslint/js": "^9.21.0",
|
|
47
|
+
"@storybook/addon-essentials": "^8.6.4",
|
|
48
|
+
"@storybook/addon-interactions": "^8.6.4",
|
|
49
|
+
"@storybook/addon-onboarding": "^8.6.4",
|
|
50
|
+
"@storybook/blocks": "^8.6.4",
|
|
51
|
+
"@storybook/react": "^8.6.4",
|
|
52
|
+
"@storybook/react-vite": "^8.6.4",
|
|
53
|
+
"@storybook/test": "^8.6.4",
|
|
54
|
+
"@testing-library/jest-dom": "^6.6.3",
|
|
55
|
+
"@testing-library/react": "^16.2.0",
|
|
56
|
+
"@types/node": "^22.13.9",
|
|
57
|
+
"@types/react": "^19.0.10",
|
|
58
|
+
"@types/react-dom": "^19.0.4",
|
|
59
|
+
"@vitejs/plugin-react": "^4.3.4",
|
|
60
|
+
"@vitest/ui": "^3.0.8",
|
|
61
|
+
"eslint": "^9.21.0",
|
|
62
|
+
"eslint-plugin-react-hooks": "^5.1.0",
|
|
63
|
+
"eslint-plugin-react-refresh": "^0.4.19",
|
|
64
|
+
"eslint-plugin-storybook": "^0.11.4",
|
|
65
|
+
"globals": "^15.15.0",
|
|
66
|
+
"jsdom": "^26.0.0",
|
|
67
|
+
"storybook": "^8.6.4",
|
|
68
|
+
"typescript": "~5.7.2",
|
|
69
|
+
"typescript-eslint": "^8.24.1",
|
|
70
|
+
"vite": "^6.2.0",
|
|
71
|
+
"vite-plugin-dts": "^4.5.3",
|
|
72
|
+
"vitest": "^3.0.8"
|
|
73
|
+
},
|
|
74
|
+
"dependencies": {
|
|
75
|
+
"@radix-ui/react-slot": "^1.1.2",
|
|
76
|
+
"@radix-ui/react-tabs": "^1.1.3",
|
|
77
|
+
"@tailwindcss/vite": "^4.0.10",
|
|
78
|
+
"class-variance-authority": "^0.7.1",
|
|
79
|
+
"clsx": "^2.1.1",
|
|
80
|
+
"lucide-react": "^0.477.0",
|
|
81
|
+
"tailwind-merge": "^3.0.2",
|
|
82
|
+
"tailwindcss": "^4.0.10",
|
|
83
|
+
"tailwindcss-animate": "^1.0.7"
|
|
84
|
+
},
|
|
85
|
+
"eslintConfig": {
|
|
86
|
+
"extends": [
|
|
87
|
+
"plugin:storybook/recommended"
|
|
88
|
+
]
|
|
89
|
+
}
|
|
90
|
+
}
|