nextworks 0.1.0-alpha.3 → 0.1.0-alpha.4
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 +11 -7
- package/dist/kits/auth-core/.nextworks/docs/AUTH_CORE_README.md +2 -2
- package/dist/kits/auth-core/.nextworks/docs/AUTH_QUICKSTART.md +2 -2
- package/dist/kits/blocks/.nextworks/docs/BLOCKS_QUICKSTART.md +3 -3
- package/dist/kits/blocks/.nextworks/docs/BLOCKS_README.md +2 -2
- package/dist/kits/data/.nextworks/docs/DATA_QUICKSTART.md +2 -2
- package/dist/kits/data/.nextworks/docs/DATA_README.md +2 -2
- package/dist/kits/forms/.nextworks/docs/FORMS_QUICKSTART.md +2 -2
- package/dist/kits/forms/.nextworks/docs/FORMS_README.md +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,10 +9,10 @@ Nextworks is a CLI that installs **modular Next.js building blocks** into your a
|
|
|
9
9
|
|
|
10
10
|
> **Status:** early‑access alpha. Expect rough edges and breaking changes between alpha releases.
|
|
11
11
|
>
|
|
12
|
-
> In this alpha, the most reliable setup is to install **Blocks** first using
|
|
12
|
+
> In this alpha, the most reliable setup is to install **Blocks** first using:
|
|
13
13
|
>
|
|
14
14
|
> ```bash
|
|
15
|
-
> npx nextworks add blocks
|
|
15
|
+
> npx nextworks add blocks --sections --templates
|
|
16
16
|
> ```
|
|
17
17
|
>
|
|
18
18
|
> and then add **Auth Core**, **Forms**, and **Data** on top. Partial setups (e.g. Auth/Data without Blocks) may require manual tweaks and are not yet fully supported.
|
|
@@ -52,10 +52,10 @@ From your app root:
|
|
|
52
52
|
### 1) Install Blocks (UI kit)
|
|
53
53
|
|
|
54
54
|
```bash
|
|
55
|
-
npx nextworks add blocks
|
|
55
|
+
npx nextworks add blocks --sections --templates
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
This copies
|
|
58
|
+
This copies:
|
|
59
59
|
|
|
60
60
|
- `components/ui/*` (core UI primitives)
|
|
61
61
|
- `components/sections/*` (reusable sections)
|
|
@@ -148,14 +148,18 @@ Then visit:
|
|
|
148
148
|
|
|
149
149
|
## Advanced Blocks installs
|
|
150
150
|
|
|
151
|
-
|
|
151
|
+
For a full UI kit including core primitives, sections, and templates, use:
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
npx nextworks add blocks --sections --templates
|
|
155
|
+
```
|
|
152
156
|
|
|
153
157
|
If you want finer control:
|
|
154
158
|
|
|
155
159
|
- `npx nextworks add blocks --ui-only` – install core UI primitives only (no sections/templates).
|
|
156
160
|
- `npx nextworks add blocks --sections` – install core + sections only.
|
|
157
161
|
- `npx nextworks add blocks --templates` – install core + templates only.
|
|
158
|
-
- `npx nextworks add blocks --sections --templates` –
|
|
162
|
+
- `npx nextworks add blocks --sections --templates` – install core + sections + templates.
|
|
159
163
|
|
|
160
164
|
---
|
|
161
165
|
|
|
@@ -168,7 +172,7 @@ You can add a short “Nextworks setup” section to your app README:
|
|
|
168
172
|
|
|
169
173
|
1. Install and run the CLI from your Next.js app root:
|
|
170
174
|
|
|
171
|
-
npx nextworks add blocks
|
|
175
|
+
npx nextworks add blocks --sections --templates
|
|
172
176
|
npx nextworks add auth-core
|
|
173
177
|
|
|
174
178
|
2. Copy environment variables:
|
|
@@ -8,10 +8,10 @@ npx nextworks add auth-core
|
|
|
8
8
|
|
|
9
9
|
> **Alpha note**
|
|
10
10
|
>
|
|
11
|
-
> In this early alpha, the Auth Core kit is tested and supported on top of
|
|
11
|
+
> In this early alpha, the Auth Core kit is tested and supported on top of a **Blocks** install that includes sections and templates. For the smoothest experience, run:
|
|
12
12
|
>
|
|
13
13
|
> ```bash
|
|
14
|
-
> npx nextworks add blocks
|
|
14
|
+
> npx nextworks add blocks --sections --templates
|
|
15
15
|
> npx nextworks add auth-core
|
|
16
16
|
> ```
|
|
17
17
|
>
|
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
Follow these steps to get email/password auth (and optional GitHub OAuth) running in under 5 minutes.
|
|
4
4
|
|
|
5
|
-
If you are using the `nextworks` CLI in your own app, the recommended alpha setup is to install Blocks first, then Auth Core:
|
|
5
|
+
If you are using the `nextworks` CLI in your own app, the recommended alpha setup is to install Blocks with sections and templates first, then Auth Core:
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npx nextworks add blocks
|
|
8
|
+
npx nextworks add blocks --sections --templates
|
|
9
9
|
npx nextworks add auth-core
|
|
10
10
|
```
|
|
11
11
|
|
|
@@ -8,17 +8,17 @@ This document explains the Blocks kit: prebuilt UI sections, templates and core
|
|
|
8
8
|
> If you are using the `nextworks` CLI in your own app, you can install this Blocks kit by running:
|
|
9
9
|
>
|
|
10
10
|
> ```bash
|
|
11
|
-
> npx nextworks add blocks
|
|
11
|
+
> npx nextworks add blocks --sections --templates
|
|
12
12
|
> ```
|
|
13
13
|
>
|
|
14
|
-
>
|
|
14
|
+
> This installs **core UI primitives, sections, and page templates**, so the example templates work out of the box. The CLI will copy files into your project under `components/`, `app/templates/`, `lib/`, and `public/` as described below.
|
|
15
15
|
>
|
|
16
16
|
> Advanced:
|
|
17
17
|
>
|
|
18
18
|
> - `npx nextworks add blocks --ui-only` → install core UI primitives only (no sections/templates).
|
|
19
19
|
> - `npx nextworks add blocks --sections` → install core + sections only.
|
|
20
20
|
> - `npx nextworks add blocks --templates` → install core + templates only.
|
|
21
|
-
> - `npx nextworks add blocks --sections --templates` →
|
|
21
|
+
> - `npx nextworks add blocks --sections --templates` → install core + sections + templates.
|
|
22
22
|
|
|
23
23
|
What’s included
|
|
24
24
|
|
|
@@ -12,9 +12,9 @@ What the kit includes
|
|
|
12
12
|
Install behavior
|
|
13
13
|
|
|
14
14
|
> **Alpha note**
|
|
15
|
-
> Other kits (Auth Core, Forms, Data) are currently tested and supported on top of a
|
|
15
|
+
> Other kits (Auth Core, Forms, Data) are currently tested and supported on top of a Blocks install that includes sections and templates. For the smoothest experience, run `npx nextworks add blocks --sections --templates` before adding additional kits.
|
|
16
16
|
|
|
17
|
-
-
|
|
17
|
+
- For a full UI kit, run `npx nextworks add blocks --sections --templates` to install **core UI primitives, sections, and templates** so the example templates work out of the box.
|
|
18
18
|
- You can pass flags to control what gets installed:
|
|
19
19
|
- `npx nextworks add blocks --ui-only` → core UI primitives only (no sections/templates).
|
|
20
20
|
- `npx nextworks add blocks --sections` → core + sections only.
|
|
@@ -7,10 +7,10 @@ Prerequisites
|
|
|
7
7
|
- A running PostgreSQL database and `DATABASE_URL` set in `.env`.
|
|
8
8
|
- Auth kit installed and configured (NextAuth + Prisma). The Data kit relies on NextAuth session for access control.
|
|
9
9
|
- In the monorepo, this is already wired up.
|
|
10
|
-
- In your own app via the CLI, the recommended alpha setup is to install Blocks + Auth Core + Forms first, then Data:
|
|
10
|
+
- In your own app via the CLI, the recommended alpha setup is to install Blocks (with sections + templates) + Auth Core + Forms first, then Data:
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
|
-
npx nextworks add blocks
|
|
13
|
+
npx nextworks add blocks --sections --templates
|
|
14
14
|
npx nextworks add auth-core
|
|
15
15
|
npx nextworks add forms
|
|
16
16
|
npx nextworks add data
|
|
@@ -10,10 +10,10 @@ and is packaged with its own kit dependencies metadata.
|
|
|
10
10
|
|
|
11
11
|
> **Alpha note**
|
|
12
12
|
>
|
|
13
|
-
> In this early alpha, the Data kit is tested and supported on top of
|
|
13
|
+
> In this early alpha, the Data kit is tested and supported on top of **Blocks** (with sections + templates), **Auth Core**, and **Forms**. For the smoothest experience, run:
|
|
14
14
|
>
|
|
15
15
|
> ```bash
|
|
16
|
-
> npx nextworks add blocks
|
|
16
|
+
> npx nextworks add blocks --sections --templates
|
|
17
17
|
> npx nextworks add auth-core
|
|
18
18
|
> npx nextworks add forms
|
|
19
19
|
> npx nextworks add data
|
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
This short doc points to the minimal example that demonstrates how to use the Forms primitives with Select, Checkbox and Switch components. It also documents the ApiResult pattern for mapping server field errors into react-hook-form and points to the per-field async validation helper used in the signup form.
|
|
4
4
|
|
|
5
|
-
> To add these examples and primitives to your own app via the CLI, the recommended alpha setup is to install Blocks first, then Forms:
|
|
5
|
+
> To add these examples and primitives to your own app via the CLI, the recommended alpha setup is to install Blocks with sections and templates first, then Forms:
|
|
6
6
|
>
|
|
7
7
|
> ```bash
|
|
8
|
-
> npx nextworks add blocks
|
|
8
|
+
> npx nextworks add blocks --sections --templates
|
|
9
9
|
> npx nextworks add forms
|
|
10
10
|
> ```
|
|
11
11
|
>
|
|
@@ -26,10 +26,10 @@ Notes
|
|
|
26
26
|
|
|
27
27
|
> **Alpha note**
|
|
28
28
|
>
|
|
29
|
-
> In this early alpha, Forms is tested on top of
|
|
29
|
+
> In this early alpha, Forms is tested on top of a **Blocks** install that includes sections and templates. For the smoothest experience, install Blocks first:
|
|
30
30
|
>
|
|
31
31
|
> ```bash
|
|
32
|
-
> npx nextworks add blocks
|
|
32
|
+
> npx nextworks add blocks --sections --templates
|
|
33
33
|
> npx nextworks add forms
|
|
34
34
|
> ```
|
|
35
35
|
>
|