initkit 1.2.0 → 1.2.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 +109 -117
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -23,7 +23,7 @@ Built with ES Modules | TypeScript Ready | Zero Config Required | Fully Document
23
23
 
24
24
  ![InitKit Demo](https://raw.githubusercontent.com/shirishshrestha/initkit/main/assets/demo.gif)
25
25
 
26
- _Creating a full-stack Next.js + Express application with InitKit_
26
+ _Creating a production-ready React application with InitKit_
27
27
 
28
28
  </div>
29
29
 
@@ -35,11 +35,11 @@ InitKit eliminates the tedious project setup process by providing intelligent sc
35
35
 
36
36
  **Key Benefits:**
37
37
 
38
- - **Live Version Fetching** - Automatically fetches latest package versions from npm registry (no hardcoded versions!)
38
+ - **CLI-First Architecture** - Uses official framework CLIs (create-next-app, create-vite, create-vue, express-generator)
39
39
  - **Smart Validation** - Real-time npm package name validation with helpful suggestions and colored feedback
40
40
  - **Enhanced CLI UX** - Beautiful formatted help text with colors, boxes, and comprehensive examples
41
- - **Monorepo Support** - Full-stack monorepo architecture with Turborepo and shared packages
42
- - **Multiple Stacks** - MERN, PERN, T3 Stack, Next.js + Express, and more
41
+ - **Always Up-to-Date** - Leverages official CLIs to ensure latest best practices and configurations
42
+ - **Non-Interactive Mode** - Properly configured for CI/CD with no hanging prompts
43
43
  - **Flexible Architecture** - Feature-based, type-based, domain-driven, clean architecture structures
44
44
  - **Docker Ready** - Complete Docker orchestration with multi-stage builds and docker-compose
45
45
  - **API Integration** - Seamless frontend-backend communication with axios interceptors
@@ -110,32 +110,30 @@ Want to contribute or add a custom template?
110
110
 
111
111
  ### 🎯 Project Types
112
112
 
113
- | Type | Description | Use Case |
114
- | ------------------- | -------------------------- | ---------------------------------- |
115
- | **Frontend Only** | Single-page applications | React, Vue, Angular, Svelte apps |
116
- | **Backend Only** | REST APIs and services | Express, Fastify, NestJS servers |
117
- | **Full Stack** | Integrated client + server | Monorepo with frontend and backend |
118
- | **Node.js Library** | Publishable npm packages | Reusable modules and utilities |
113
+ | Type | Description | Use Case |
114
+ | ------------------- | ------------------------ | -------------------------------- |
115
+ | **Frontend Only** | Single-page applications | React, Vue, Next.js apps |
116
+ | **Backend Only** | REST APIs and services | Express, NestJS, Fastify servers |
117
+ | **Node.js Library** | Publishable npm packages | Reusable modules and utilities |
119
118
 
120
119
  ### 🎨 Framework Support
121
120
 
122
121
  **Frontend Frameworks:**
123
122
 
124
- - React (with Create React App or Vite)
125
- - Vue.js (Vue CLI or Vite)
126
- - Angular (Angular CLI)
127
- - Svelte (SvelteKit)
128
- - Next.js (App Router & Pages Router)
129
- - Nuxt.js (Vue 3)
130
- - Vanilla JavaScript (Modern ES6+)
123
+ - React + Vite (Fast HMR, modern build tool)
124
+ - Next.js (App Router with TypeScript)
125
+ - Vue.js + Vite (Progressive framework)
131
126
 
132
127
  **Backend Frameworks:**
133
128
 
134
129
  - Express.js (Minimalist & flexible)
135
- - Fastify (High performance)
136
- - Koa (Next-gen Express)
137
- - NestJS (Enterprise TypeScript)
138
- - Hapi (Configuration-centric)
130
+
131
+ **Coming Soon:**
132
+
133
+ - NestJS (Enterprise TypeScript) - Code ready, testing in progress
134
+ - Fastify (High performance) - Code ready, testing in progress
135
+ - Nuxt.js (Vue 3) - Code ready, testing in progress
136
+ - Svelte (Modern reactivity) - Code ready, testing in progress
139
137
 
140
138
  **Databases:**
141
139
 
@@ -168,31 +166,7 @@ Want to contribute or add a custom template?
168
166
  - Environment variables (.env setup)
169
167
  - Turborepo (monorepo build system)
170
168
 
171
- ### 🏗️ Full-Stack Architectures
172
-
173
- **Monorepo (Turborepo):**
174
-
175
- - Shared packages (types, UI components)
176
- - Unified workspace management
177
- - Optimized build pipeline
178
- - Consistent tooling across apps
179
-
180
- **Traditional Stack Options:**
181
-
182
- - **MERN** - MongoDB + Express + React + Node
183
- - **PERN** - PostgreSQL + Express + React + Node
184
- - **Next.js + Express** - Full-stack React with API
185
- - **Laravel + React** - PHP backend with React frontend
186
-
187
- **Features:**
188
-
189
- - API integration (Vite proxy, Next.js rewrites)
190
- - Docker orchestration (frontend + backend + database)
191
- - Environment configuration
192
- - Shared TypeScript types
193
- - Reusable UI components
194
-
195
- ### 🎨 Styling Solutions
169
+ ### Styling Solutions
196
170
 
197
171
  | Solution | Description | Best For |
198
172
  | --------------------- | ------------------------------- | ------------------------------ |
@@ -341,90 +315,98 @@ my-react-app/
341
315
  └── package.json
342
316
  ```
343
317
 
344
- ### Example 2: Full Stack MERN with Docker
318
+ ### Example 2: Next.js with TypeScript
345
319
 
346
320
  ```bash
347
- initkit fullstack-app
348
- # Select: Full StackTraditionalMERN
321
+ initkit nextjs-app
322
+ # Select: Frontend OnlyNext.jsTypeScript → Tailwind CSS
349
323
  ```
350
324
 
351
325
  **Generated Structure:**
352
326
 
353
327
  ```
354
- fullstack-app/
355
- ├── client/ # React + Vite frontend
356
- │ ├── src/
357
- │ │ ├── features/
358
- │ │ ├── components/
359
- │ └── lib/api.js
360
- │ ├── Dockerfile
361
- │ └── package.json
362
- ├── server/ # Express backend
363
- ├── src/
364
- │ │ ├── controllers/
365
- │ │ ├── models/
366
- │ │ └── routes/
367
- │ ├── Dockerfile
368
- │ └── package.json
369
- ├── docker-compose.yml # MongoDB + Frontend + Backend
370
- └── README.md
328
+ nextjs-app/
329
+ ├── src/
330
+ │ ├── app/
331
+ │ │ ├── page.tsx
332
+ │ │ └── layout.tsx
333
+ ├── components/
334
+ │ ├── features/
335
+ │ └── lib/
336
+ ├── public/
337
+ ├── .eslintrc.json
338
+ ├── next.config.js
339
+ ├── tsconfig.json
340
+ ├── tailwind.config.js
341
+ └── package.json
371
342
  ```
372
343
 
373
- ### Example 3: Monorepo with Turborepo
344
+ ### Example 3: Vue with TypeScript
374
345
 
375
346
  ```bash
376
- initkit my-monorepo
377
- # Select: Full StackMonorepoNext.js + Express + PostgreSQL
347
+ initkit vue-app
348
+ # Select: Frontend OnlyVueTypeScript Tailwind CSS
378
349
  ```
379
350
 
380
351
  **Generated Structure:**
381
352
 
382
353
  ```
383
- my-monorepo/
384
- ├── apps/
385
- │ ├── frontend/ # Next.js app
386
- └── backend/ # Express API
387
- ├── packages/
388
- │ ├── shared-types/ # Shared TypeScript interfaces
389
- └── ui-components/ # Shared React components
390
- ├── turbo.json # Turborepo config
391
- ├── docker-compose.yml
354
+ vue-app/
355
+ ├── src/
356
+ │ ├── components/
357
+ ├── features/
358
+ ├── composables/
359
+ │ ├── stores/
360
+ ├── router/
361
+ ├── App.vue
362
+ │ └── main.ts
363
+ ├── public/
364
+ ├── vite.config.ts
365
+ ├── tsconfig.json
392
366
  └── package.json
393
367
  ```
394
368
 
395
- ### Example 4: Express API with Docker
369
+ ### Example 4: Express Backend API
396
370
 
397
371
  ```bash
398
372
  initkit api-server
399
- # Select: Backend Only → Express → MongoDBTypeScript → Docker + GitHub Actions
373
+ # Select: Backend Only → Express → JavaScriptMVC structure
400
374
  ```
401
375
 
402
- **Features:**
376
+ **Generated Structure:**
403
377
 
404
- - RESTful API structure
405
- - MongoDB connection setup
406
- - Docker multi-stage build
407
- - GitHub Actions CI/CD
408
- - Environment variable management
378
+ ```
379
+ api-server/
380
+ ├── models/
381
+ ├── controllers/
382
+ ├── routes/
383
+ │ ├── index.js
384
+ │ └── users.js
385
+ ├── middlewares/
386
+ ├── services/
387
+ ├── .env.example
388
+ ├── app.js
389
+ └── package.json
390
+ ```
409
391
 
410
392
  ### Example 5: Quick Start with Defaults
411
393
 
412
394
  ```bash
413
395
  initkit quick-app --yes
414
- # Creates a full-stack app with React + Express + TypeScript
396
+ # Creates a React + Vite app with TypeScript + Tailwind CSS
415
397
  ```
416
398
 
417
399
  ---
418
400
 
419
401
  ## Interactive Prompt Flow
420
402
 
421
- InitKit uses an intelligent 13-question flow that adapts based on your project type:
403
+ InitKit uses an intelligent question flow that adapts based on your project type:
422
404
 
423
- 1. **Project Type** - Frontend, Backend, Full Stack, or Library
405
+ 1. **Project Type** - Frontend, Backend, or Library
424
406
  2. **Project Name** - With real-time validation and suggestions
425
- 3. **Frontend Framework** - Shown for Frontend/Full Stack projects
426
- 4. **Backend Framework** - Shown for Backend/Full Stack projects
427
- 5. **Database** - Shown for Backend/Full Stack projects
407
+ 3. **Frontend Framework** - Shown for Frontend projects
408
+ 4. **Backend Framework** - Shown for Backend projects
409
+ 5. **Database/ORM** - Shown for Backend projects
428
410
  6. **Language** - TypeScript (recommended) or JavaScript
429
411
  7. **Folder Structure** - Feature-based, Type-based, Domain-driven, or Flat
430
412
  8. **TypeScript Strictness** - Strict, Moderate, or Relaxed (if TS selected)
@@ -444,12 +426,12 @@ See [QUESTION_FLOW.md](./QUESTION_FLOW.md) for the complete decision tree.
444
426
 
445
427
  Unlike other scaffolding tools, InitKit generates **truly production-ready** projects:
446
428
 
447
- - **Latest Dependencies** - Fetches actual latest versions from npm registry (not hardcoded)
448
- - **No Manual Setup Required** - Everything configured and ready to deploy
449
- - **Best Practices Built-in** - Error boundaries, loading states, proper TypeScript types
450
- - **Security First** - Environment variables, input validation, secure authentication patterns
451
- - **Performance Optimized** - Code splitting, lazy loading, optimized bundle sizes
452
- - **Deployment Ready** - Docker files, CI/CD pipelines, health checks included
429
+ - **Official CLIs** - Uses create-next-app, create-vite, create-vue, express-generator for best practices
430
+ - **Always Current** - Leverages framework maintainers' latest configurations
431
+ - **No Hanging** - Properly configured non-interactive mode for CI/CD pipelines
432
+ - **TypeScript First** - Full TypeScript support with proper configurations
433
+ - **Best Practices Built-in** - ESLint, Prettier, proper folder structures
434
+ - **Package Manager Choice** - Full support for npm, yarn, pnpm, and bun
453
435
 
454
436
  ### 🚀 Developer Experience
455
437
 
@@ -729,33 +711,43 @@ initkit my-app --verbose
729
711
 
730
712
  ## Recent Updates
731
713
 
732
- ### Version 1.1.0 (Latest)
714
+ ### Version 1.2.0 (Latest) 🚀
715
+
716
+ **🎉 BREAKING CHANGES:**
733
717
 
734
- **🎉 Major Features:**
718
+ - **Removed fullstack project type** - Simplified to focus on stable frontend and backend options
719
+ - **Migrated to CLI-first architecture** - Now uses official framework CLIs exclusively
735
720
 
736
- - **Live NPM Version Fetching** - Automatically fetches latest package versions from npm registry
737
- - 🎯 **New Libraries Added**:
738
- - Redux Toolkit & React Redux (state management)
739
- - Jotai (atomic state)
740
- - React Router (routing)
741
- - React Icons (icon library)
742
- - Radix UI (headless components)
743
- - ShadCN UI (component library)
744
- - 📦 **Bun Support** - Added bun as a package manager option
721
+ **✨ Major Features:**
722
+
723
+ - **CLI-First Architecture** - Uses official CLIs for all frameworks:
724
+ - `create-next-app` for Next.js projects
725
+ - `create-vite@5.1.0` for React (pinned for stability)
726
+ - `create-vue` with `--typescript --default` for Vue
727
+ - `express-generator` for Express backends
728
+ - **Enhanced Logging** - Emoji-based progress indicators (📦) with detailed command visibility
729
+ - **Non-Interactive Mode** - All frameworks properly configured for CI/CD (no hanging prompts)
745
730
 
746
731
  **🐛 Bug Fixes:**
747
732
 
748
- - Fixed TypeScript config errors (Next.js, Vue, Express)
749
- - Fixed Express backend feature-based structure directory errors
750
- - Fixed package manager selection for yarn, pnpm, and bun
751
- - Fixed Next.js tsconfig to properly include `src/**/*.ts` patterns
733
+ - Fixed package manager override bug (CLI default removed)
734
+ - Fixed create-vite@8.x hanging (pinned to stable v5.1.0)
735
+ - Fixed create-vue prompting (added --default flag)
736
+ - Fixed CI environment variable for non-interactive execution
752
737
 
753
738
  **🔧 Improvements:**
754
739
 
755
- - All templates now fetch actual latest versions from npm (React 19+, Vite 7+, Next.js 16+)
756
- - Enhanced error messages with better troubleshooting suggestions
757
- - Improved directory structure handling across all architecture patterns
758
- - Better fallback handling when npm registry is unreachable
740
+ - Always uses latest framework configurations from official CLIs
741
+ - Better error messages and rollback handling
742
+ - Cleaner codebase with removed legacy template files
743
+ - All tests passing (48/48)
744
+
745
+ **📊 Test Results:**
746
+
747
+ - React + Vite: ✅ 16.5s (218 packages)
748
+ - Next.js: ✅ 26.9s (347 packages)
749
+ - Vue: ✅ 16.2s (153 packages)
750
+ - Express: ✅ 12.3s (53 packages)
759
751
 
760
752
  ---
761
753
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "initkit",
3
- "version": "1.2.0",
3
+ "version": "1.2.1",
4
4
  "type": "module",
5
5
  "description": "A modern CLI tool for scaffolding production-ready web projects with live npm version fetching, multiple frameworks, and best practices built-in",
6
6
  "main": "src/index.js",