v1.2.2Stable

InitKit Documentation

The fastest way to bootstrap modern web projects. InitKit provides intelligent scaffolding for React, Vue, Next.js, Express, and full-stack applications with best practices built-in.

Quick Start

1

Install InitKit

Get started with InitKit using your preferred package manager:

Terminal
npx initkit my-app

Pro Tip

You don't need to install InitKit globally. Just run npx initkit and you're ready to go!
2

Choose Your Stack

InitKit will guide you through an interactive setup:

Interactive Prompts
? What type of project do you want to create?
› Frontend Only
  Backend Only
  Full-Stack Application
  Node.js Library/Package

? Select your frontend framework:
› React
  Vue
  Next.js
  Svelte
3

Start Building

Navigate to your project and start the development server:

Terminal
cd my-app
npm run dev

Success!

Your project is now running at http://localhost:3000

Features

Interactive CLI

Beautiful terminal UI guides you through setup with intelligent defaults and validations.

Lightning Fast

Optimized templates with minimal dependencies. Get up and running in seconds, not minutes.

Multiple Templates

Choose from React, Vue, Next.js, Express, or full-stack configurations.

Smart Defaults

ESLint, Prettier, TypeScript, and Git configured out of the box.

Production Ready

Industry best practices and optimizations baked into every template.

Package Manager Agnostic

Works seamlessly with npm, yarn, pnpm, or bun.

CLI Options

Customize your project setup with these command-line options:

PropTypeDefaultDescription
--template
stringSpecify template: 'react', 'vue', 'nextjs', 'express', or 'fullstack'
--packageManager
stringChoose package manager: 'npm', 'yarn', 'pnpm', or 'bun'
--git
booleantrueInitialize a Git repository
--skip-install
booleanSkip automatic dependency installation
Example: Create Next.js project with pnpm
npx initkit my-app --template nextjs --packageManager pnpm --git

Advanced Usage

Using a Specific Template

bash
npx initkit my-app --template react --packageManager yarn

Skip Dependency Installation

bash
npx initkit my-app --skip-install

Note

Use --skip-install to defer package installation. Useful for CI/CD pipelines or when you want to review dependencies first.

Disable Git Initialization

bash
npx initkit my-app --no-git

Available Templates

React

Popular

Modern React setup with Vite, TypeScript, ESLint, and Prettier. Includes routing, state management setup, and component examples.

bash
npx initkit my-react-app --template react

Next.js

Popular

Production-ready Next.js with App Router, TypeScript, Tailwind CSS, and optimized configurations.

bash
npx initkit my-nextjs-app --template nextjs

Express

Backend API with Express, TypeScript, middleware, and database setup. Includes authentication and error handling.

bash
npx initkit my-backend --template express

Full-Stack

Monorepo

Complete full-stack setup with frontend and backend in a monorepo structure. Perfect for unified deployment.

bash
npx initkit my-fullstack-app --template fullstack

Troubleshooting

Permission Errors

If you encounter permission errors on Unix systems, try running with sudo or ensure your user has proper npm permissions.

Network Issues

If package installation fails due to network issues, try using a different package manager or check your proxy settings.

Node Version

InitKit requires Node.js 18.0.0 or higher. Run node --version to check your version.

Ready to build something amazing?

Get started with InitKit today and experience the fastest way to scaffold modern web projects.

bash
npx initkit my-app