create-asterui 0.1.0 → 0.1.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 +60 -0
- package/package.json +1 -1
- package/templates/js/src/App.jsx +1 -1
- package/templates/ts/src/App.tsx +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# create-asterui
|
|
2
|
+
|
|
3
|
+
Scaffold a new [AsterUI](https://asterui.com) project with Vite, Tailwind CSS v4, and DaisyUI v5.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm create asterui
|
|
9
|
+
# or
|
|
10
|
+
pnpm create asterui
|
|
11
|
+
# or
|
|
12
|
+
yarn create asterui
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## What it does
|
|
16
|
+
|
|
17
|
+
- Creates a new Vite + React project
|
|
18
|
+
- Configures Tailwind CSS v4 and DaisyUI v5
|
|
19
|
+
- Installs AsterUI and react-hook-form
|
|
20
|
+
- Sets up theme configuration (light/dark, business/corporate, or custom)
|
|
21
|
+
- Supports TypeScript or JavaScript
|
|
22
|
+
|
|
23
|
+
## Options
|
|
24
|
+
|
|
25
|
+
The CLI will prompt you for:
|
|
26
|
+
|
|
27
|
+
- **Project name** - Directory name for your project
|
|
28
|
+
- **Language** - TypeScript (recommended) or JavaScript
|
|
29
|
+
- **Themes** - Light/Dark, Business/Corporate, All themes, or custom selection
|
|
30
|
+
- **Package manager** - npm, pnpm, or yarn (auto-detected)
|
|
31
|
+
|
|
32
|
+
## After scaffolding
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
cd your-project
|
|
36
|
+
npm run dev
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Optional components
|
|
40
|
+
|
|
41
|
+
Some AsterUI components require additional peer dependencies and use separate imports:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
# For Chart component
|
|
45
|
+
npm install apexcharts
|
|
46
|
+
import { Chart } from 'asterui/chart'
|
|
47
|
+
|
|
48
|
+
# For QRCode component
|
|
49
|
+
npm install qrcode
|
|
50
|
+
import { QRCode } from 'asterui/qrcode'
|
|
51
|
+
|
|
52
|
+
# For VirtualList component
|
|
53
|
+
npm install @tanstack/react-virtual
|
|
54
|
+
import { VirtualList } from 'asterui/virtuallist'
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Links
|
|
58
|
+
|
|
59
|
+
- [AsterUI Documentation](https://asterui.com)
|
|
60
|
+
- [GitHub](https://github.com/edadma/asterui)
|
package/package.json
CHANGED
package/templates/js/src/App.jsx
CHANGED
package/templates/ts/src/App.tsx
CHANGED