svforge 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 +19 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,27 +1,32 @@
|
|
|
1
|
-
#
|
|
1
|
+
# SVForge
|
|
2
2
|
|
|
3
3
|
**sv community addon** — SvelteKit starter templates built on Skeleton UI v4 and Tailwind CSS v4. Adds production-ready UI components, auth (Better Auth), database (Drizzle + SQLite), and admin dashboard to new SvelteKit projects.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
#
|
|
9
|
-
|
|
8
|
+
# Base template
|
|
9
|
+
bunx sv create my-app --template minimal --types ts --add svforge --install bun
|
|
10
10
|
cd my-app && bun dev
|
|
11
|
+
|
|
12
|
+
# Fullstack template (auth + DB + admin)
|
|
13
|
+
bunx sv create my-app --template minimal --types ts --add 'svforge=template:fullstack' --install bun
|
|
14
|
+
cd my-app && cp .env.example .env && bunx drizzle-kit push && bun dev
|
|
11
15
|
```
|
|
12
16
|
|
|
13
17
|
Or step by step:
|
|
14
18
|
```bash
|
|
15
|
-
|
|
19
|
+
bunx sv create my-app --template minimal --types ts
|
|
16
20
|
cd my-app
|
|
17
|
-
|
|
21
|
+
bunx sv add svforge # prompts: base or fullstack
|
|
18
22
|
```
|
|
19
23
|
|
|
20
24
|
## What you get — Base
|
|
21
25
|
|
|
22
26
|
- **15 UI components** — Button, Card, Badge, Avatar, Alert, Input, Select, Textarea, Checkbox, Toggle, Accordion, Tabs, Table, Breadcrumb, ThemeToggle
|
|
23
27
|
- **2 layout components** — Navbar (responsive), Footer
|
|
24
|
-
- **
|
|
28
|
+
- **SVForge theme** — custom oklch color palette
|
|
29
|
+
- **Dark/light mode** — auto-detects system preference, manual toggle
|
|
25
30
|
- **Demo page** at `/demo-ui`
|
|
26
31
|
|
|
27
32
|
## What you get — Fullstack
|
|
@@ -31,10 +36,11 @@ Everything from Base, plus:
|
|
|
31
36
|
- **Better Auth** — email/password, sessions, protected routes
|
|
32
37
|
- **Drizzle + SQLite** — schema auto-generated
|
|
33
38
|
- **Admin dashboard** (`/admin`) — stats, user CRUD, settings
|
|
39
|
+
- **Setup page** (`/setup`) — dev-only, create first admin user
|
|
34
40
|
|
|
35
41
|
```bash
|
|
36
|
-
cp .env.example .env &&
|
|
37
|
-
# Visit /
|
|
42
|
+
cp .env.example .env && bunx drizzle-kit push && bun dev
|
|
43
|
+
# Visit /setup to create your admin, then /login
|
|
38
44
|
```
|
|
39
45
|
|
|
40
46
|
## Usage
|
|
@@ -45,8 +51,7 @@ cp .env.example .env && npx drizzle-kit push && bun dev
|
|
|
45
51
|
</script>
|
|
46
52
|
|
|
47
53
|
<Button variant="filled" color="primary" size="lg">Get Started</Button>
|
|
48
|
-
<Button variant="
|
|
49
|
-
<Button variant="glass" color="secondary">Glass</Button>
|
|
54
|
+
<Button variant="tonal" color="success">Tonal</Button>
|
|
50
55
|
<Button loading={saving}>Saving...</Button>
|
|
51
56
|
<Button href="/about">Link Button</Button>
|
|
52
57
|
|
|
@@ -63,7 +68,7 @@ cp .env.example .env && npx drizzle-kit push && bun dev
|
|
|
63
68
|
|
|
64
69
|
| Prop | Values | Default |
|
|
65
70
|
|------|--------|---------|
|
|
66
|
-
| variant | `filled` `outlined` `tonal` `ghost`
|
|
71
|
+
| variant | `filled` `outlined` `tonal` `ghost` | `filled` |
|
|
67
72
|
| color | `primary` `secondary` `tertiary` `success` `warning` `error` `surface` | `primary` |
|
|
68
73
|
| size | `sm` `md` `lg` | `md` |
|
|
69
74
|
| loading | `boolean` | `false` |
|
|
@@ -122,8 +127,9 @@ cd /tmp/test && bun install && bun dev
|
|
|
122
127
|
|
|
123
128
|
## Links
|
|
124
129
|
|
|
125
|
-
- [npm](https://www.npmjs.com/package
|
|
126
|
-
- [GitHub](https://github.com/
|
|
130
|
+
- [npm](https://www.npmjs.com/package/svforge)
|
|
131
|
+
- [GitHub](https://github.com/lelabdev/svforge)
|
|
132
|
+
- [Org](https://www.npmjs.com/org/svforge)
|
|
127
133
|
|
|
128
134
|
## License
|
|
129
135
|
|
package/package.json
CHANGED