JSPM

  • Created
  • Published
  • Downloads 168
  • Score
    100M100P100Q90650F
  • License MIT

πŸš€ Official CLI for MVPBlocks - Copy, paste, customizeβ€”and launch your idea faster than ever!

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 (mvpblocks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    πŸš€ MVPBlocks CLI

    The official command-line interface for MVPBlocks - Copy, paste, customizeβ€”and launch your idea faster than ever!

    MVPBlocks CLI allows you to quickly add beautiful, responsive components to your React/Next.js projects directly from your terminal.

    ✨ Features

    • 🎨 Beautiful Terminal UI - Stunning ASCII art and colorful interface
    • πŸ” Smart Search - Find components by name, description, or category
    • πŸ“¦ Auto Dependencies - Automatically installs required packages
    • πŸ”„ TypeScript & JavaScript - Support for both TS and JS projects
    • πŸ—οΈ Organized Structure - Components are organized by type and category
    • ⚑ Lightning Fast - Quick installation and setup

    πŸ› οΈ Installation

    You don't need to install the CLI globally. Use it directly with npx:

    npx mvpblocks --help

    πŸ“š Usage

    List all available components

    npx mvpblocks list

    Add a component to your project

    npx mvpblocks add button
    npx mvpblocks add hero-1

    Search for components

    npx mvpblocks search hero
    npx mvpblocks search button

    View component categories

    npx mvpblocks categories

    Get detailed component information

    npx mvpblocks info button
    npx mvpblocks info hero-1

    Force language preference

    # Force TypeScript
    npx mvpblocks add button --ts
    
    # Force JavaScript
    npx mvpblocks add button --js

    🎯 Commands

    Command Description Example
    list List all available components npx mvpblocks list
    add <component> Add a component to your project npx mvpblocks add button
    search <query> Search for components npx mvpblocks search hero
    categories List all available categories npx mvpblocks categories
    info <component> Get detailed component information npx mvpblocks info button
    help Show help message npx mvpblocks help

    πŸ—οΈ Project Structure

    After adding components, your project will have this structure:

    your-project/
    β”œβ”€β”€ components/
    β”‚   β”œβ”€β”€ ui/           # Basic UI components (buttons, inputs, etc.)
    β”‚   └── mvpblocks/    # Block components (heroes, features, etc.)
    β”œβ”€β”€ hooks/            # Custom React hooks
    β”œβ”€β”€ lib/
    β”‚   └── utils.ts      # Utility functions (automatically created)
    └── ...

    πŸ”§ Options

    • --ts, --typescript - Force TypeScript output
    • --js, --javascript - Force JavaScript output
    • --help, -h - Show help message

    πŸ“‹ Requirements

    • Node.js 18 or higher
    • A React/Next.js project with Tailwind CSS
    • Package manager: npm, yarn, pnpm, or bun

    🎨 Component Types

    • UI Components (registry:ui) - Basic building blocks like buttons, inputs, cards
    • Block Components (registry:block) - Complete sections like heroes, features, testimonials
    • Hooks (registry:hook) - Custom React hooks for enhanced functionality
    • Library (registry:lib) - Utility functions and helpers

    πŸš€ Quick Start

    1. Create a new Next.js project (if you don't have one):

      npx create-next-app@latest my-project --typescript --tailwind --eslint
      cd my-project
    2. Add your first component:

      npx mvpblocks add button
    3. Use the component in your project:

      import { Button } from "@/components/ui/button"
      
      export default function App() {
        return (
          <Button>Click me</Button>
        )
      }

    🀝 Contributing

    We welcome contributions! Please see our Contributing Guide for details.

    πŸ“ License

    MIT License - see the LICENSE file for details.

    πŸ‘¨β€πŸ’» Author

    Subhadeep Roy


    Made with ❀️ for the developer community