create-gm-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.
Files changed (2) hide show
  1. package/README.md +89 -66
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,28 +1,19 @@
1
1
  # create-gm-app
2
2
 
3
- ๐Ÿš€ A professional CLI tool to scaffold modern **Web** and **Mobile** applications with a clean, production-ready setup.
3
+ ![npm version](https://img.shields.io/npm/v/create-gm-app)
4
+ ![npm downloads](https://img.shields.io/npm/dm/create-gm-app)
4
5
 
5
- ---
6
-
7
- ## โœจ Features
8
-
9
- * โšก Fast project scaffolding using **npx**
10
- * ๐ŸŒ Web stack (Next.js + Tailwind + shadcn/ui)
11
- * ๐Ÿ“ฑ Mobile stack (Expo + HeroUI + Uniwind)
12
- * ๐Ÿง  Smart interactive CLI (Inquirer-based)
13
- * ๐Ÿงน Clean project structure out of the box
14
- * ๐Ÿ”ง Minimal but scalable architecture
15
- * ๐Ÿงฉ Built for extensibility (future stacks)
6
+ ๐Ÿš€ Scaffold modern **Web (Next.js)** and **Mobile (Expo)** apps with a clean, production-ready setup.
16
7
 
17
8
  ---
18
9
 
19
- ## ๐Ÿ“ฆ Installation (No global install required)
10
+ ## โšก Quick Usage
20
11
 
21
12
  ```bash
22
13
  npx create-gm-app
23
14
  ```
24
15
 
25
- Or specify directly:
16
+ Or:
26
17
 
27
18
  ```bash
28
19
  npx create-gm-app web my-app
@@ -31,46 +22,93 @@ npx create-gm-app mobile my-app
31
22
 
32
23
  ---
33
24
 
25
+ ## ๐Ÿงฑ Stacks
26
+
27
+ ### ๐ŸŒ Web
28
+
29
+ - Next.js (App Router)
30
+ - TypeScript
31
+ - Tailwind CSS
32
+ - shadcn/ui
33
+
34
+ ### ๐Ÿ“ฑ Mobile
35
+
36
+ - Expo
37
+ - HeroUI Native
38
+ - Uniwind
39
+ - Reanimated + Gesture Handler
40
+
41
+ ---
42
+
43
+ ## โœจ Core Features
44
+
45
+ - Interactive CLI (Inquirer)
46
+ - Clean, scalable architecture
47
+ - Production-ready setup
48
+
49
+ ---
50
+
51
+ ## ๐Ÿ“š Full Documentation
52
+
53
+ For complete setup details, customization options, development workflow, and roadmap:
54
+
55
+ ๐Ÿ‘‰ https://github.com/gilbertmunuotz/gm-cli-tool
56
+
57
+ ---
58
+
59
+ # ๐Ÿ“– GitHub Documentation (Full)
60
+
61
+ ## โœจ Features
62
+
63
+ - โšก Fast project scaffolding using **npx**
64
+ - ๐ŸŒ Web stack (Next.js + Tailwind + shadcn/ui)
65
+ - ๐Ÿ“ฑ Mobile stack (Expo + HeroUI + Uniwind)
66
+ - ๐Ÿง  Smart interactive CLI (Inquirer-based)
67
+ - ๐Ÿงน Clean project structure out of the box
68
+ - ๐Ÿ”ง Minimal but scalable architecture
69
+ - ๐Ÿงฉ Built for extensibility (future stacks)
70
+
71
+ ---
72
+
34
73
  ## ๐Ÿงฑ Supported Stacks
35
74
 
36
75
  ### ๐ŸŒ Web Stack
37
76
 
38
- * Next.js (App Router)
39
- * TypeScript
40
- * Tailwind CSS
41
- * shadcn/ui
42
- * ESLint
43
- * React Compiler (enabled)
77
+ - Next.js (App Router)
78
+ - TypeScript
79
+ - Tailwind CSS
80
+ - shadcn/ui
81
+ - ESLint
82
+ - React Compiler (enabled)
44
83
 
45
84
  #### Optional Customization
46
85
 
47
- * `src/` directory
48
- * Import alias (`@/*`)
49
- * AGENTS.md support
86
+ - `src/` directory
87
+ - Import alias (`@/*`)
88
+ - AGENTS.md support
50
89
 
51
90
  ---
52
91
 
53
92
  ### ๐Ÿ“ฑ Mobile Stack
54
93
 
55
- * Expo (latest)
56
- * TypeScript
57
- * HeroUI Native
58
- * Uniwind (Tailwind for React Native)
59
- * React Native Reanimated
60
- * Gesture Handler
94
+ - Expo (latest)
95
+ - TypeScript
96
+ - HeroUI Native
97
+ - Uniwind (Tailwind for React Native)
98
+ - React Native Reanimated
99
+ - Gesture Handler
61
100
 
62
101
  #### Includes
63
102
 
64
- * Clean folder structure:
103
+ ```
104
+ app/
105
+ components/
106
+ lib/
107
+ hooks/
108
+ ```
65
109
 
66
- ```
67
- app/
68
- components/
69
- lib/
70
- hooks/
71
- ```
72
- * Babel configured for Reanimated
73
- * Reset of default Expo boilerplate
110
+ - Babel configured for Reanimated
111
+ - Reset of default Expo boilerplate
74
112
 
75
113
  ---
76
114
 
@@ -82,14 +120,6 @@ npx create-gm-app mobile my-app
82
120
  npx create-gm-app
83
121
  ```
84
122
 
85
- Youโ€™ll be prompted to choose:
86
-
87
- * Project type (Web / Mobile)
88
- * Project name
89
- * Customization options
90
-
91
- ---
92
-
93
123
  ### Direct Mode
94
124
 
95
125
  ```bash
@@ -103,29 +133,22 @@ npx create-gm-app mobile my-app
103
133
 
104
134
  ```
105
135
  gm-stack/
106
- โ”œโ”€โ”€ bin/ # CLI entry
136
+ โ”œโ”€โ”€ bin/
107
137
  โ”œโ”€โ”€ src/
108
- โ”‚ โ”œโ”€โ”€ cli/ # CLI logic
109
- โ”‚ โ”œโ”€โ”€ commands/ # Commands (create, etc.)
110
- โ”‚ โ”œโ”€โ”€ templates/ # Web & Mobile templates
111
- โ”‚ โ””โ”€โ”€ utils/ # Helpers (validation, etc.)
138
+ โ”‚ โ”œโ”€โ”€ cli/
139
+ โ”‚ โ”œโ”€โ”€ commands/
140
+ โ”‚ โ”œโ”€โ”€ templates/
141
+ โ”‚ โ””โ”€โ”€ utils/
112
142
  ```
113
143
 
114
144
  ---
115
145
 
116
146
  ## ๐Ÿ› ๏ธ Development
117
147
 
118
- Clone the repo:
119
-
120
148
  ```bash
121
- git clone https://github.com/your-username/gm-stack.git
149
+ git clone https://github.com/gilbertmunuotz/gm-stack.git
122
150
  cd gm-stack
123
151
  npm install
124
- ```
125
-
126
- Run locally:
127
-
128
- ```bash
129
152
  npm link
130
153
  npm run build
131
154
  npx create-gm-app
@@ -135,17 +158,17 @@ npx create-gm-app
135
158
 
136
159
  ## ๐Ÿ“Œ Roadmap
137
160
 
138
- * [ ] More templates (e.g., SaaS starter, dashboard)
139
- * [ ] Plugin system
140
- * [ ] Config file support (`gm.config.json`)
141
- * [ ] CI/CD presets
142
- * [ ] Database integrations (Prisma, Supabase)
161
+ - [ ] More templates (SaaS, dashboards)
162
+ - [ ] Plugin system
163
+ - [ ] Config support (`gm.config.json`)
164
+ - [ ] CI/CD presets
165
+ - [ ] Database integrations (Prisma, Supabase)
143
166
 
144
167
  ---
145
168
 
146
169
  ## ๐Ÿค Contributing
147
170
 
148
- Contributions are welcome. Feel free to open issues or submit PRs.
171
+ PRs and issues are welcome.
149
172
 
150
173
  ---
151
174
 
@@ -158,4 +181,4 @@ MIT License
158
181
  ## ๐Ÿ‘ค Author
159
182
 
160
183
  **Gilbert Munuo**
161
- Aspiring Software Developer | Builder of scalable developer tools
184
+ ๐ŸŒ https://www.gilbertmunuotz.com
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-gm-app",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Official CLI to scaffold GM Stack apps",
5
5
  "bin": {
6
6
  "create-gm-app": "./bin/create-gm-stack.js"
@@ -38,4 +38,4 @@
38
38
  "ts-node": "^10.9.2",
39
39
  "typescript": "^6.0.2"
40
40
  }
41
- }
41
+ }