JSPM

  • Created
  • Published
  • Downloads 7
  • Score
    100M100P100Q67373F
  • License MIT

Ship production-ready web and mobile projects in 60 seconds. Create Next.js, React, T3 Stack, MERN, or Expo React Native apps with TypeScript, Tailwind CSS, and modern tooling - then deploy instantly to Vercel, Netlify, Railway, or Render.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (quickship-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    QuickShip CLI Logo

    QuickShip CLI ⚡

    Ship production-ready projects in 60 seconds

    npm version License: MIT Node

    Stop wasting hours on boilerplate. Create production-ready web and mobile apps with TypeScript, Tailwind CSS, and modern tooling - fully configured in under 60 seconds.

    Getting StartedTemplatesCommandsDeploy


    🎥 See It In Action

    QuickShip Demo

    Create production-ready projects in 60 seconds


    🎯 Why QuickShip?

    Traditional Setup With QuickShip
    ❌ 30-60 minutes setup 60 seconds
    ❌ Manual configuration Fully automated
    ❌ Version conflicts Latest stable versions
    ❌ Missing best practices Production-ready
    ❌ Complex deployment One command deploy

    🚀 Getting Started

    Installation

    Option 1: No Installation (Recommended)

    Use npx to run QuickShip without installing:

    npx quickship-cli@latest build my-app

    Option 2: Global Install

    Install once, use everywhere:

    npm install -g quickship-cli

    Basic Usage

    The simplest way to create a project:

    quickship build my-app

    QuickShip will ask you a few questions and create your project. That's it!

    What you get:

    • ✅ TypeScript configured
    • ✅ Tailwind CSS ready
    • ✅ Git initialized
    • ✅ Dependencies installed
    • ✅ ESLint + Prettier setup
    • ✅ Development server ready

    Then start coding:

    cd my-app
    npm run dev

    Your app is now running! 🎉


    Skip the Questions (Headless Mode)

    Want to skip all prompts? Use the -y flag:

    # Uses sensible defaults (Next.js, TypeScript, Tailwind, npm, Git)
    quickship build my-app -y

    Advanced Usage

    Customize with flags:

    # Specify template
    quickship build my-app --template nextjs -y
    
    # Choose package manager
    quickship build my-app -p pnpm -y
    
    # Skip Git initialization
    quickship build my-app --no-git -y
    
    # Skip dependency installation (for CI/CD)
    quickship build my-app --no-install -y
    
    # Combine options
    quickship build my-app --template vite -p yarn --no-git -y

    Available flags:

    Flag Description Example
    -y, --yes Skip all prompts quickship build my-app -y
    -t, --template <n> Choose template --template nextjs
    -p, --package-manager <pm> Choose package manager -p pnpm
    --no-git Skip Git initialization quickship build my-app --no-git
    --no-install Skip installing dependencies quickship build my-app --no-install
    -v, --verbose Show detailed logs quickship build my-app -v

    🚀 Templates

    Choose from 6 production-ready templates for web, mobile, and backend:

    🌐 Web Development

    Next.js

    Recommended

    Full-stack React framework with server components and API routes.

    Stack:

    • Next.js 15+
    • React 19
    • TypeScript
    • Tailwind CSS
    • App Router
    quickship build my-app \
      --template nextjs -y

    T3 Stack

    Type-safe full-stack with tRPC, Prisma, and NextAuth.

    Stack:

    • Next.js
    • tRPC
    • Prisma
    • NextAuth
    • TypeScript
    • Tailwind CSS
    quickship build my-app \
      --template t3-stack -y

    React + Vite

    Lightning-fast React SPA development.

    Stack:

    • React 18+
    • Vite 7+
    • TypeScript
    • Tailwind CSS v4
    • React Router
    quickship build my-app \
      --template vite -y

    MERN Stack

    Full-stack with MongoDB, Express, React, and Node.js.

    Stack: MongoDB • Express • React • Node.js • TypeScript • Tailwind CSS

    quickship build my-app --template mern-stack -y

    📱 Mobile Development

    Expo React Native

    Cross-platform mobile apps for iOS, Android, and Web.

    Stack: Expo SDK 52+ • React Native • TypeScript • Expo Router

    Features:

    • 📂 Tabs or Blank template
    • 🎨 StyleSheet (default) or NativeWind (Tailwind CSS)
    • 🧭 File-based routing with Expo Router
    • 📱 Test instantly with Expo Go
    • 🌐 Runs on iOS, Android, and Web
    quickship build my-app --template expo-react-native -y

    🔌 Backend / API Development

    Express + TypeScript API

    Recommended

    Fast, flexible RESTful API with TypeScript and your choice of database.

    Stack: Express.js • TypeScript • Prisma/Mongoose • JWT Auth (optional) • Swagger (optional)

    Features:

    • 🚀 Express.js 4+ with TypeScript
    • 💾 PostgreSQL (Prisma), MongoDB (Mongoose), or SQLite
    • 🔐 JWT Authentication (optional)
    • 📚 Swagger API Documentation (optional)
    • 🐳 Docker Support (optional)
    • ✅ Zod Validation
    • 🧪 Jest Testing
    quickship build my-api --template express-api -y

    NestJS API

    Coming Soon

    Enterprise-grade API with modular architecture (implementation in progress).


    🛠️ Commands

    Core Commands

    # Create a new project (interactive)
    quickship build
    
    # Create with a name (interactive)
    quickship build my-app
    
    # Create with defaults (no prompts)
    quickship build my-app -y
    
    # List all available templates
    quickship list
    
    # Add features to existing project
    quickship add <feature>

    Project Management

    # Show detailed project information
    quickship info
    
    # Check project and environment health
    quickship doctor
    
    # View all templates with details
    quickship templates
    
    # Update CLI to latest version
    quickship update

    Deployment

    # Deploy to production (interactive)
    quickship deploy
    
    # Deploy to specific platform
    quickship deploy --platform vercel
    
    # Skip confirmations
    quickship deploy -y

    Get Help

    # Show all commands
    quickship --help
    
    # Show help for specific command
    quickship build --help
    
    # Show CLI version
    quickship --version

    🚢 Deployment

    Deploy your project with a single command:

    cd my-app
    quickship deploy

    Supported Platforms:

    Platform Best For Features
    Vercel Next.js, T3 Stack Zero-config, Edge functions, CI/CD
    Netlify Vite, Next.js Fast CDN, Deploy previews, Forms
    Railway MERN Stack MongoDB support, $5 free credit
    Render MERN Stack Free tier, Managed databases

    What it does:

    • 🔍 Auto-detects your project type
    • ✅ Validates build setup
    • 🔐 Handles platform authentication
    • 🔑 Manages environment variables
    • 🚀 Deploys to production
    • 🌐 Returns live URL

    ✨ Features

    Add Features After Creation

    Enhance your Next.js projects:

    cd my-app
    
    # Add shadcn/ui components
    quickship add shadcn
    
    # Add NextAuth.js authentication
    quickship add auth
    
    # Add Prisma database
    quickship add database

    Health Check

    Verify your environment and project setup:

    quickship doctor

    Checks:

    • Node.js version
    • Package managers
    • Git installation
    • Project structure
    • Dependencies
    • Environment variables
    • TypeScript config

    Project Info

    Get detailed project information:

    quickship info

    Shows:

    • Project type
    • Tech stack
    • Available commands
    • Features to add

    📚 Examples

    Example 1: Quick Next.js App

    # Fastest way - uses defaults
    quickship build my-saas -y
    
    cd my-saas
    npm run dev
    # ✨ App running at http://localhost:3000

    Example 2: Interactive Setup

    # Answer a few questions
    quickship build my-app
    
    # QuickShip asks:
    # ? What do you want to build? Website
    # ? Choose your stack: Next.js
    # ? Add shadcn/ui? Yes
    # ? Package manager: npm
    # ? Initialize Git? Yes
    
    cd my-app
    npm run dev

    Example 3: Add Features After Creation

    # Create a basic Next.js app
    quickship build my-saas -y
    
    cd my-saas
    
    # Add shadcn/ui components
    quickship add shadcn
    
    # Add authentication with NextAuth.js
    quickship add auth
    
    # Add database with Prisma
    quickship add database
    
    # ✨ Now you have a full-stack app with auth and database!
    npm run dev

    Example 4: MERN Stack with Custom Options

    # Full control with flags
    quickship build my-api \
      --template mern-stack \
      -p pnpm \
      -y
    
    # Configure MongoDB
    cd my-api/server
    cp .env.example .env
    # Edit .env with your MongoDB URI
    
    # Run both client and server
    cd ..
    pnpm dev

    Example 5: Mobile App

    # Create Expo app
    quickship build my-mobile-app
    
    # Choose:
    # ? What do you want to build? Mobile App
    # ? Choose mobile stack: Expo React Native
    # ? Choose template: Tabs
    # ? Styling: StyleSheet
    
    cd my-mobile-app
    npx expo start
    
    # Scan QR code with Expo Go app! 📱

    Example 6: Deploy to Production

    # Create app
    quickship build my-next-app -y
    
    cd my-next-app
    
    # Deploy in one command
    quickship deploy --platform vercel
    
    # ✨ Your app is live!

    Example 7: CI/CD Pipeline

    # Perfect for automated deployments
    quickship build production-app \
      --template nextjs \
      -p npm \
      --no-git \
      -y
    
    cd production-app
    npm run build
    npm run start

    🎯 Comparison

    Feature QuickShip create-next-app create-vite create-expo-app
    Web Templates ✅ 4 templates ✅ 1 ✅ Many
    Mobile Templates ✅ Expo ✅ 1
    TypeScript ✅ Default ✅ Optional ✅ Optional ✅ Optional
    Tailwind CSS ✅ Pre-configured ❌ Manual ❌ Manual ❌ Manual
    Deployment ✅ One command ❌ Manual ❌ Manual ❌ Manual
    Add Features ✅ CLI commands ❌ Manual ❌ Manual ❌ Manual
    Health Check ✅ Built-in
    Project Info ✅ Built-in

    💻 Requirements

    • Node.js: 18.0.0 or higher
    • npm: 9.0.0 or higher (or pnpm, yarn, bun)
    • Git: Any recent version (optional)
    • OS: Windows, macOS, or Linux

    🗺️ Roadmap

    ✅ Released (v0.10)

    • ✅ Next.js, Vite, T3 Stack, MERN templates
    • ✅ Expo React Native mobile development
    • ✅ shadcn/ui integration
    • ✅ NextAuth.js integration (quickship add auth)
    • ✅ Prisma database integration (quickship add database)
    • ✅ One-command deployment (Vercel, Netlify, Railway, Render)
    • ✅ Health check and project info
    • ✅ Headless mode for CI/CD

    🚀 Coming Soon (v0.11+)

    • 🔜 More Expo templates (drawer, stack navigation)
    • 🔜 Supabase integration
    • 🔜 Component generator
    • 🔜 More auth provider integrations (Clerk, Auth0)
    • 🔜 More database integrations (PlanetScale, Supabase)
    • 🔜 Astro, SvelteKit, Remix templates

    🌟 Future (v1.0+)

    • Browser extension templates
    • Desktop app templates (Electron, Tauri)
    • Visual project builder
    • Custom template marketplace
    • Team collaboration features

    🤝 Contributing

    Contributions are welcome! Here's how you can help:

    1. Star this repo ⭐ - Show your support
    2. Report bugs 🐛 - Open an issue
    3. Request features 💡 - Start a discussion
    4. Submit PRs 🔧 - Fork, code, and submit

    Development Setup

    # Clone the repo
    git clone https://github.com/SeifElkadyy/QuickShip-CLI.git
    cd QuickShip-CLI
    
    # Install dependencies
    npm install
    
    # Link for local testing
    npm link
    
    # Test it out
    quickship build test-app

    📝 License

    MIT License - see LICENSE file for details.


    🙏 Acknowledgments

    Built with these amazing tools:

    Inspired by create-next-app, create-t3-app, create-vite, and create-expo-app.


    💖 Support QuickShip

    QuickShip is free and open-source. If it saves you time:

    Star on GitHub

    Support development:

    Donate

    Your support helps:

    • 🚀 Add more templates
    • 🐛 Fix bugs faster
    • ✨ Build new features
    • 📚 Improve documentation

    📞 Get Help


    Built with ❤️ for developers who want to ship fast

    Get StartedView TemplatesCommands

    Version 0.10.21 | MIT License