create-abp-react

create-abp-react

A CLI tool to quickly scaffold a new ABP React application.

Installation

This package is designed to be run via npx, so you don't need to install it globally:

npx create-abp-react [folder-name]

Requirements

• Node.js >= 18.0.0
• pnpm - Install with one of the following:

  npm install -g pnpm
  

  or

  corepack enable pnpm
  

Usage

Basic Usage

Create a new ABP React app in the default folder (abp-react-app):

npx create-abp-react

With Custom Folder Name

Create a new ABP React app in a custom folder:

npx create-abp-react my-app

You can also use relative paths:

npx create-abp-react ./my-project

Help

Display help information:

npx create-abp-react --help

Version

Display version information:

npx create-abp-react --version

What It Does

When you run create-abp-react, it will:

• ✅ Fetch the latest template from abp-react-template-basic
• ✅ Check if pnpm is installed (exits with helpful message if not)
• ✅ Install all dependencies using pnpm
• ✅ Initialize a new git repository
• ✅ Provide you with next steps to get started

Getting Started

After creating your project:

cd abp-react-app  # or your custom folder name
pnpm dev

Documentation

For more information about ABP React, visit the official documentation:

https://docs.abpjs.io/docs/

Template Repository

The template used by this tool is available at:

https://github.com/abpjs/abp-react-template-basic

License

MIT