design-system-silkhaus 0.0.0

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Rayyamhk
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,39 @@
1
+ # Vite React Component Library Starter
2
+
3
+ This is a starter template for creating React component libraries using Vite. It includes a robust set of features to help you develop, test, and build your library efficiently.
4
+
5
+ ## Features
6
+
7
+ - React: A JavaScript library for web and native user interfaces.
8
+ - TypeScript: A strongly typed superset of JavaScript.
9
+ - Tailwind: A utility-first CSS framework.
10
+ - Storybook: A frontend workshop for building UI components and pages in isolation.
11
+ - Vite: A next generation frontend tooling that runs and builds your library incredibly fast.
12
+ - Vitest: A next generation testing framework.
13
+ - ESLint: A tool that finds and fixes problems in your code.
14
+ - Prettier: A code formatter.
15
+ - Husky: A pre-commit hook.
16
+ - Github Action: A tool that deploys your Storybook to GitHub page automatically.
17
+
18
+ ## Get Started
19
+
20
+ 1. Clone this repository
21
+ 2. Install dependencies using `npm i` (or `pnpm i` if you like)
22
+ 3. To see storybook locally use `npm run dev` (or `pnpm dev` if you like)
23
+ 4. To see storybook locally use `npm run dev` (or `pnpm dev` if you like)
24
+
25
+ ## Scripts
26
+
27
+ - `dev`: Starts the local Storybook server, use this to develop and preview your components.
28
+ - `test`: Runs all your tests with vitest.
29
+ - `test:watch`: Runs tests in watch mode.
30
+ - `test:ui`: Runs tests with a UI.
31
+ - `test:coverage`: Runs tests and generates a coverage report.
32
+ - `build`: Builds your Storybook as a static web application.
33
+ - `build:lib`: Builds your component library with Vite.
34
+ - `lint`: Runs ESLint.
35
+ - `format`: Formats your code with Prettier.
36
+
37
+ ## License
38
+
39
+ MIT