@trapar-waves/react-tailwind 1.0.0 → 1.0.3

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.
Files changed (2) hide show
  1. package/README.md +93 -17
  2. package/package.json +32 -13
package/README.md CHANGED
@@ -1,29 +1,105 @@
1
- # Rsbuild Project
1
+ # @trapar-waves/react-tailwind
2
2
 
3
- ## Setup
3
+ ![npm version](https://img.shields.io/npm/v/@trapar-waves/react-tailwind)
4
+ ![npm dm](https://img.shields.io/npm/dm/@trapar-waves/react-tailwind)
5
+ ![License](https://img.shields.io/badge/license-MIT-green)
6
+ ![GitHub last commit](https://img.shields.io/github/last-commit/Trapar-waves/react-tailwind)
4
7
 
5
- Install the dependencies:
8
+ > A React project with Tailwind CSS integrated for modern, utility-first styling.
6
9
 
7
- ```bash
8
- pnpm install
9
- ```
10
+ ## ✨ Features
10
11
 
11
- ## Get Started
12
+ * **Modern UI Framework:** Built using React, offering a component-driven architecture for building reusable UI elements.
13
+ * **Utility-First Styling:** Employs Tailwind CSS for highly customizable and rapid styling through utility classes.
14
+ * **Fast Development Workflow:** Utilizes Rsbuild for quick server starts, hot module replacement, and optimized production builds.
15
+ * **Type Safety:** Leverages TypeScript to enhance code reliability and reduce runtime errors.
16
+ * **Icon Integration:** Integrates Iconify for scalable, customizable icons in the UI.
17
+ * **Focus on Code Quality:** Includes ESLint configured with Antfu’s popular configuration, ensuring consistent coding standards.
18
+ * **PostCSS Optimization:** Uses Tailwind CSS PostCSS plugin for enhanced CSS optimization and compatibility.
12
19
 
13
- Start the dev server:
20
+ ## 🚀 Getting Started
14
21
 
15
- ```bash
16
- pnpm dev
17
- ```
22
+ Follow these instructions to get the project running locally.
18
23
 
19
- Build the app for production:
24
+ ### Prerequisites
20
25
 
21
- ```bash
22
- pnpm build
23
- ```
26
+ * Ensure you have the following installed:
27
+ * Node.js (>= 18.x recommended)
28
+ * Package manager (npm, yarn, or pnpm)
29
+ ```bash
30
+ node -v
31
+ npm -v # or yarn -v or pnpm -v
32
+ ```
33
+
34
+ ### Installation
24
35
 
25
- Preview the production build locally:
36
+ 1. Clone the repository:
37
+ ```bash
38
+ git clone https://github.com/Trapar-waves/react-tailwind.git
39
+ cd react-tailwind
40
+ ```
41
+ 2. Install dependencies:
42
+ ```bash
43
+ # Use your preferred package manager
44
+ npm install
45
+ # or
46
+ yarn install
47
+ # or
48
+ pnpm install
49
+ ```
26
50
 
51
+ ## 🛠️ Usage
52
+
53
+ Explain how to run and use the project after installation.
54
+
55
+ ### Available Scripts
56
+
57
+ Common scripts available via `npm run <script>`, `yarn <script>`, or `pnpm <script>`:
58
+
59
+ * `dev`: Starts the development server with automatic browser opening.
60
+ * `build`: Creates a production-ready build of the application.
61
+ * `preview`: Previews the production build locally before deployment.
62
+
63
+ Example:
27
64
  ```bash
28
- pnpm preview
65
+ # Start development server
66
+ npm run dev
67
+
68
+ # Create production build
69
+ npm run build
70
+
71
+ # Preview the production build
72
+ npm run preview
29
73
  ```
74
+
75
+ ## 💻 Tech Stack
76
+
77
+ Key technologies used in this project include:
78
+
79
+ * **Framework/Library:** React
80
+ * **UI Toolkit/Styling:** Tailwind CSS
81
+ * **Build Tool:** Rsbuild
82
+ * **Language:** TypeScript
83
+ * **Code Quality:** ESLint with Antfu configuration
84
+ * **Icons:** Iconify
85
+
86
+ See the [package.json](package.json) for a full list of dependencies.
87
+
88
+ ## 🤝 Contributing
89
+
90
+ Contributions are welcome!
91
+
92
+ ## 📄 License
93
+
94
+ Distributed under the **MIT** License. See `LICENSE` file for more information.
95
+
96
+ ## 👤 Author
97
+
98
+ * **Rikka** ([Muromi-Rikka](https://github.com/Muromi-Rikka))
99
+ * Email: admin@rikka.cc
100
+
101
+ ## 🔗 Links
102
+
103
+ * **Repository:** [https://github.com/Trapar-waves/react-tailwind](https://github.com/Trapar-waves/react-tailwind)
104
+ * **Homepage:** [https://github.com/Trapar-waves/react-tailwind](https://github.com/Trapar-waves/react-tailwind)
105
+ * **Issues:** [https://github.com/Trapar-waves/react-tailwind/issues](https://github.com/Trapar-waves/react-tailwind/issues)
package/package.json CHANGED
@@ -1,7 +1,26 @@
1
1
  {
2
2
  "name": "@trapar-waves/react-tailwind",
3
3
  "type": "module",
4
- "version": "1.0.0",
4
+ "version": "1.0.3",
5
+ "author": {
6
+ "email": "admin@rikka.cc",
7
+ "name": "Rikka",
8
+ "url": "https://github.com/Muromi-Rikka"
9
+ },
10
+ "homepage": "https://github.com/Trapar-waves/react-tailwind",
11
+ "repository": {
12
+ "type": "git",
13
+ "url": "git+https://github.com/Trapar-waves/react-tailwind.git"
14
+ },
15
+ "bugs": {
16
+ "url": "https://github.com/Trapar-waves/react-tailwind/issues"
17
+ },
18
+ "keywords": [
19
+ "react",
20
+ "rsbuild",
21
+ "tailwind",
22
+ "iconify"
23
+ ],
5
24
  "publishConfig": {
6
25
  "access": "public"
7
26
  },
@@ -11,20 +30,20 @@
11
30
  "preview": "rsbuild preview"
12
31
  },
13
32
  "dependencies": {
14
- "react": "^19.0.0",
15
- "react-dom": "^19.0.0"
33
+ "react": "^19.1.0",
34
+ "react-dom": "^19.1.0"
16
35
  },
17
36
  "devDependencies": {
18
- "@antfu/eslint-config": "^4.0.0",
19
- "@iconify/json": "^2.2.298",
37
+ "@antfu/eslint-config": "^4.12.0",
38
+ "@iconify/json": "^2.2.326",
20
39
  "@iconify/tailwind4": "^1.0.6",
21
- "@rsbuild/core": "^1.2.1",
22
- "@rsbuild/plugin-react": "^1.1.0",
23
- "@tailwindcss/postcss": "^4.0.0",
24
- "@types/react": "^19.0.7",
25
- "@types/react-dom": "^19.0.3",
26
- "eslint": "^9.18.0",
27
- "tailwindcss": "^4.0.0",
28
- "typescript": "^5.7.3"
40
+ "@rsbuild/core": "^1.3.6",
41
+ "@rsbuild/plugin-react": "^1.2.0",
42
+ "@tailwindcss/postcss": "^4.1.3",
43
+ "@types/react": "^19.1.1",
44
+ "@types/react-dom": "^19.1.2",
45
+ "eslint": "^9.24.0",
46
+ "tailwindcss": "^4.1.3",
47
+ "typescript": "^5.8.3"
29
48
  }
30
49
  }