@dasidev/dasi-ui 1.0.0 → 1.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 +71 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @dasidev/dasi-ui
|
|
2
2
|
|
|
3
3
|
A starter Vue 3 + TypeScript framework for building configurable, enterprise-ready web apps. It ships with a configuration-driven architecture, unified components, and type-safe development. Forms are powered by Vueform, which serves as the built-in form builder across the project.
|
|
4
4
|
|
|
@@ -6,34 +6,73 @@ A starter Vue 3 + TypeScript framework for building configurable, enterprise-rea
|
|
|
6
6
|
|
|
7
7
|
Make sure you guys use node v20 or above
|
|
8
8
|
|
|
9
|
-
###
|
|
9
|
+
### Create New Project
|
|
10
10
|
|
|
11
11
|
```sh
|
|
12
|
-
npm
|
|
13
|
-
|
|
12
|
+
# Using npm (recommended)
|
|
13
|
+
npx @dasidev/dasi-ui create my-admin-app
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
# Using yarn
|
|
16
|
+
yarn create @dasidev/dasi-ui my-admin-app
|
|
16
17
|
|
|
17
|
-
|
|
18
|
-
|
|
18
|
+
# Using pnpm
|
|
19
|
+
pnpm create @dasidev/dasi-ui my-admin-app
|
|
19
20
|
```
|
|
20
21
|
|
|
21
|
-
###
|
|
22
|
+
### Install as Library
|
|
22
23
|
|
|
23
24
|
```sh
|
|
24
|
-
|
|
25
|
-
|
|
25
|
+
# Using npm
|
|
26
|
+
npm install @dasidev/dasi-ui
|
|
26
27
|
|
|
27
|
-
|
|
28
|
+
# Using yarn
|
|
29
|
+
yarn add @dasidev/dasi-ui
|
|
28
30
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
+
# Using pnpm
|
|
32
|
+
pnpm add @dasidev/dasi-ui
|
|
31
33
|
```
|
|
32
34
|
|
|
33
|
-
###
|
|
35
|
+
### Requirements
|
|
36
|
+
- Node.js: v20 or above
|
|
37
|
+
-Package Manager: npm v10+, yarn, or pnpm
|
|
38
|
+
|
|
39
|
+
## 📦 Usage
|
|
34
40
|
|
|
35
41
|
```sh
|
|
36
|
-
|
|
42
|
+
# Create new project with interactive setup
|
|
43
|
+
npx @dasidev/dasi-ui create my-admin-app
|
|
44
|
+
|
|
45
|
+
# Follow the prompts to configure:
|
|
46
|
+
# - Project title and description
|
|
47
|
+
# - Template (default/minimal/full)
|
|
48
|
+
# - Features (auth, charts, maps, forms)
|
|
49
|
+
# - Package manager
|
|
50
|
+
# - TypeScript support
|
|
51
|
+
# - API configuration
|
|
52
|
+
# - Dark mode
|
|
53
|
+
|
|
54
|
+
# Navigate to project directory
|
|
55
|
+
cd my-admin-app
|
|
56
|
+
|
|
57
|
+
# Install dependencies
|
|
58
|
+
npm install
|
|
59
|
+
|
|
60
|
+
# Run development server
|
|
61
|
+
npm run dev
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### As Component Library
|
|
65
|
+
``` typescript
|
|
66
|
+
<template>
|
|
67
|
+
<DasiApp>
|
|
68
|
+
<PageActivity endpoint="/users" />
|
|
69
|
+
</DasiApp>
|
|
70
|
+
</template>
|
|
71
|
+
|
|
72
|
+
<script setup>
|
|
73
|
+
import { DasiApp, PageActivity } from '@dasidev/dasi-ui'
|
|
74
|
+
import '@dasidev/dasi-ui/style.css'
|
|
75
|
+
</script>
|
|
37
76
|
```
|
|
38
77
|
|
|
39
78
|
## 🏗️ Architecture Overview
|
|
@@ -291,6 +330,21 @@ Components are styled with Tailwind classes and support:
|
|
|
291
330
|
- **Disabled States**: Proper disabled styling
|
|
292
331
|
- **Loading States**: Loading indicators
|
|
293
332
|
|
|
333
|
+
## 🎯 CLI Features
|
|
334
|
+
|
|
335
|
+
The CLI provides interactive setup with:
|
|
336
|
+
- Template Selection: Default, Minimal, or Full-featured
|
|
337
|
+
- Feature Toggles: Authentication, Charts, Maps, Forms
|
|
338
|
+
- Package Manager: npm, yarn, or pnpm
|
|
339
|
+
- TypeScript: Optional TypeScript support
|
|
340
|
+
- API Configuration: Custom API endpoints
|
|
341
|
+
- Theming: Dark mode support
|
|
342
|
+
|
|
343
|
+
Available Templates
|
|
344
|
+
- Default - Complete admin dashboard with all core features
|
|
345
|
+
- Minimal - Basic admin setup with essential components
|
|
346
|
+
- Full - All features including charts, maps, and advanced forms
|
|
347
|
+
|
|
294
348
|
## 📚 Key Libraries
|
|
295
349
|
|
|
296
350
|
- **Vue 3** - Main framework with Composition API
|
|
@@ -337,6 +391,8 @@ VITE_APP_NAME=My Application
|
|
|
337
391
|
VITE_COMPANY_NAME=My Company
|
|
338
392
|
```
|
|
339
393
|
|
|
394
|
+
🚀 Ready to build your next admin dashboard? Start with npx @dasidev/dasi-ui create my-app!
|
|
395
|
+
|
|
340
396
|
### Vite Configuration
|
|
341
397
|
|
|
342
398
|
See [Vite Configuration Reference](https://vitejs.dev/config/) for advanced configuration options.
|