@asynx/create-asynx-next-app 1.0.0 → 1.0.2

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.
Files changed (2) hide show
  1. package/README.md +35 -84
  2. package/package.json +10 -4
package/README.md CHANGED
@@ -1,111 +1,62 @@
1
- # create-asynx-next-app
1
+ > ⚡ Create scalable Next.js apps using opinionated App Router templates — by **Asynx Devs Pvt Ltd**
2
2
 
3
- > Opinionated Next.js App Router scaffolder by **Asynx Devs Pvt Ltd**
3
+ ## Why create-asynx-next-app?
4
4
 
5
- A modern, open-source CLI to scaffold **scalable Next.js applications** using production-ready templates — from simple landing pages to complex SaaS apps.
5
+ `create-next-app` gives you a starting point.
6
6
 
7
- -----
7
+ `create-asynx-next-app` gives you a **direction**.
8
8
 
9
- ## ✨ Features
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
- * ✅ **Next.js (latest)** — App Router only
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
- pnpm create asynx-next-app my-app
15
+ npx create-asynx-next-app my-app
16
+ cd my-app
17
+ pnpm dev
30
18
  ```
31
19
 
32
- ### Using npx
20
+ or using pnpm
33
21
 
34
22
  ```bash
35
- npx create-asynx-next-app my-app
23
+ pnpm create asynx-next-app my-app
36
24
  ```
37
25
 
38
- -----
39
-
40
- ## 🧩 Templates
41
-
42
- | Template | Best for: |
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 |
26
+ ## Template Selection
47
27
 
48
- -----
28
+ During setup, you will be prompted to choose a template:
49
29
 
50
- ## 📁 Project Structure
30
+ - **Simple** — landing pages, MVPs, small tools
31
+ - **Moderate** — dashboards, content platforms, startups
32
+ - **SaaS** — scalable, domain-driven architecture for real products
51
33
 
52
- All generated projects follow this structure:
34
+ Templates differ only in structure — you own all the code.
53
35
 
54
36
  ```
55
- src/
56
- ├─ app/
57
- ├─ components/
58
- ├─ lib/
59
- ├─ utils/
60
- └─ types/
61
- ```
62
-
63
- With route groups such as:
64
37
 
65
- * `(marketing)`
66
- * `(auth)`
67
- * `(dashboard)`
38
+ ## No Vendor Lock-in
68
39
 
69
- -----
40
+ This tool is used **only at project creation time**.
70
41
 
71
- ## 🛠 Included Utilities
42
+ - No Asynx packages are required at runtime
43
+ - No hidden dependencies
44
+ - You can delete this CLI after scaffolding
72
45
 
73
- Each project includes commonly used helpers:
46
+ Your project is a standard Next.js app.
74
47
 
75
- * Date & time formatting
76
- * Relative time helpers
77
- * Number & currency formatting
78
- * String utilities
79
- * Async helpers
48
+ ## Who is this for?
80
49
 
81
- > 💡 **Note:** Utilities are copied into your project — you fully own the code.
50
+ - Founders building MVPs
51
+ - Startups building dashboards or SaaS apps
52
+ - Developers who want structure without overengineering
53
+ - Teams tired of rebuilding the same Next.js setup
82
54
 
83
- -----
55
+ ## Support & Feedback
84
56
 
85
- ## 🧠 Philosophy
57
+ If you find issues or have ideas:
86
58
 
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
-
93
- > You can delete this CLI after creation — your project will continue to work.
94
-
95
- -----
96
-
97
- ## 🤝 Contributing
98
-
99
- Contributions are welcome\! Please read:
100
-
101
- * [CONTRIBUTING.md](https://www.google.com/search?q=CONTRIBUTING.md)
102
- * [CODE\_OF\_CONDUCT.md](https://www.google.com/search?q=CODE_OF_CONDUCT.md)
103
-
104
- -----
105
-
106
- ## 🏢 About Asynx Devs Pvt Ltd
107
-
108
- Asynx Devs builds scalable web products, internal tools, and SaaS platforms.
109
-
110
- * 🌐 **Website:** [https://asynx.in](https://asynx.in)
111
- * 🐙 **GitHub:** [https://github.com/Asynx-Pvt-Ltd](https://github.com/Asynx-Pvt-Ltd)
59
+ - Reach out via https://asynx.in/contact
60
+ - 🐙 GitHub: https://github.com/Asynx-Pvt-Ltd/create-asynx-next-app
61
+ - Improvements, suggestions, and feedback are welcome
62
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@asynx/create-asynx-next-app",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Opinionated Next.js App Router scaffolder by Asynx Devs",
5
5
  "type": "module",
6
6
  "bin": {
@@ -12,10 +12,16 @@
12
12
  "prepublishOnly": "pnpm build"
13
13
  },
14
14
  "keywords": [
15
+ "next.js templates",
15
16
  "nextjs",
16
- "cli",
17
- "scaffolding",
18
- "",
17
+ "create-next-app",
18
+ "nextjs-cli",
19
+ "nextjs-app-router",
20
+ "scaffold",
21
+ "boilerplate",
22
+ "starter",
23
+ "saas",
24
+ "mvp",
19
25
  "asynx"
20
26
  ],
21
27
  "repository": {