@asynx/create-asynx-next-app 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 +37 -83
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,111 +1,65 @@
|
|
|
1
|
-
|
|
1
|
+
> ⚡ Create scalable Next.js apps using opinionated App Router templates — by **Asynx Devs Pvt Ltd**
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## Why create-asynx-next-app?
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
`create-next-app` gives you a starting point.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
`create-asynx-next-app` gives you a **direction**.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
This CLI scaffolds **real-world Next.js architectures** — from simple MVPs to
|
|
10
|
+
SaaS-grade applications — without locking you into any framework or vendor.
|
|
10
11
|
|
|
11
|
-
|
|
12
|
-
* ✅ **TypeScript by default**
|
|
13
|
-
* ✅ **Multiple templates**
|
|
14
|
-
* Simple (Landing pages, MVPs)
|
|
15
|
-
* Moderate (Dashboards, content platforms)
|
|
16
|
-
* SaaS (Scalable, domain-driven architecture)
|
|
17
|
-
* ✅ **Predefined utilities included**
|
|
18
|
-
* ✅ **No vendor lock-in**
|
|
19
|
-
* ✅ **`pnpm` / `npm` / `npx` supported**
|
|
20
|
-
* ✅ **Cross-platform (Windows, macOS, Linux)**
|
|
21
|
-
|
|
22
|
-
-----
|
|
23
|
-
|
|
24
|
-
## 🚀 Usage
|
|
25
|
-
|
|
26
|
-
### Using pnpm (recommended)
|
|
12
|
+
## Quick Start
|
|
27
13
|
|
|
28
14
|
```bash
|
|
29
|
-
|
|
15
|
+
npx create-asynx-next-app my-app
|
|
16
|
+
cd my-app
|
|
17
|
+
pnpm dev
|
|
30
18
|
```
|
|
31
19
|
|
|
32
|
-
|
|
20
|
+
or using pnpm
|
|
33
21
|
|
|
34
22
|
```bash
|
|
35
|
-
|
|
23
|
+
pnpm create asynx-next-app my-app
|
|
36
24
|
```
|
|
37
25
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
## 🧩 Templates
|
|
26
|
+
# 5️⃣ Clarify template selection (avoid confusion)
|
|
41
27
|
|
|
42
|
-
|
|
43
|
-
| :--- | :--- |
|
|
44
|
-
| **Simple App** | Landing pages, Small tools, MVPs |
|
|
45
|
-
| **Moderate App** | Dashboards, Content platforms, Early-stage startups |
|
|
46
|
-
| **SaaS / Complex App** | SaaS products, Multi-tenant systems, Role-based platforms |
|
|
28
|
+
Add this section:
|
|
47
29
|
|
|
48
|
-
|
|
30
|
+
```md
|
|
31
|
+
## Template Selection
|
|
49
32
|
|
|
50
|
-
|
|
33
|
+
During setup, you will be prompted to choose a template:
|
|
51
34
|
|
|
52
|
-
|
|
35
|
+
- **Simple** — landing pages, MVPs, small tools
|
|
36
|
+
- **Moderate** — dashboards, content platforms, startups
|
|
37
|
+
- **SaaS** — scalable, domain-driven architecture for real products
|
|
53
38
|
|
|
39
|
+
Templates differ only in structure — you own all the code.
|
|
54
40
|
```
|
|
55
|
-
src/
|
|
56
|
-
├─ app/
|
|
57
|
-
├─ components/
|
|
58
|
-
├─ lib/
|
|
59
|
-
├─ utils/
|
|
60
|
-
└─ types/
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
With route groups such as:
|
|
64
|
-
|
|
65
|
-
* `(marketing)`
|
|
66
|
-
* `(auth)`
|
|
67
|
-
* `(dashboard)`
|
|
68
|
-
|
|
69
|
-
-----
|
|
70
|
-
|
|
71
|
-
## 🛠 Included Utilities
|
|
72
|
-
|
|
73
|
-
Each project includes commonly used helpers:
|
|
74
|
-
|
|
75
|
-
* Date & time formatting
|
|
76
|
-
* Relative time helpers
|
|
77
|
-
* Number & currency formatting
|
|
78
|
-
* String utilities
|
|
79
|
-
* Async helpers
|
|
80
|
-
|
|
81
|
-
> 💡 **Note:** Utilities are copied into your project — you fully own the code.
|
|
82
|
-
|
|
83
|
-
-----
|
|
84
|
-
|
|
85
|
-
## 🧠 Philosophy
|
|
86
|
-
|
|
87
|
-
* This is **not a framework**.
|
|
88
|
-
* No runtime dependencies on Asynx packages
|
|
89
|
-
* No hidden abstractions
|
|
90
|
-
* No lock-in
|
|
91
|
-
* Clean, understandable code
|
|
92
41
|
|
|
93
|
-
|
|
42
|
+
## No Vendor Lock-in
|
|
94
43
|
|
|
95
|
-
|
|
44
|
+
This tool is used **only at project creation time**.
|
|
96
45
|
|
|
97
|
-
|
|
46
|
+
- No Asynx packages are required at runtime
|
|
47
|
+
- No hidden dependencies
|
|
48
|
+
- You can delete this CLI after scaffolding
|
|
98
49
|
|
|
99
|
-
|
|
50
|
+
Your project is a standard Next.js app.
|
|
100
51
|
|
|
101
|
-
|
|
102
|
-
* [CODE\_OF\_CONDUCT.md](https://www.google.com/search?q=CODE_OF_CONDUCT.md)
|
|
52
|
+
## Who is this for?
|
|
103
53
|
|
|
104
|
-
|
|
54
|
+
- Founders building MVPs
|
|
55
|
+
- Startups building dashboards or SaaS apps
|
|
56
|
+
- Developers who want structure without overengineering
|
|
57
|
+
- Teams tired of rebuilding the same Next.js setup
|
|
105
58
|
|
|
106
|
-
##
|
|
59
|
+
## Support & Feedback
|
|
107
60
|
|
|
108
|
-
|
|
61
|
+
If you find issues or have ideas:
|
|
109
62
|
|
|
110
|
-
|
|
111
|
-
|
|
63
|
+
- Reach out via https://asynx.in/contact
|
|
64
|
+
- 🐙 GitHub: https://github.com/Asynx-Pvt-Ltd/create-asynx-next-app
|
|
65
|
+
- Improvements, suggestions, and feedback are welcome
|