create-once-ui-app
v1.0.1
Published
CLI tool to create Once UI projects using the Next.js starter kit
Readme
create-once-ui-app
A CLI tool to quickly create new projects using the Once UI Next.js starter kit.
Features
- Clones the official Once UI Next.js starter kit
- Interactive CLI interface
- Option to create project in current directory or new folder
- Automatic dependency installation
- Simple and straightforward setup process
Installation
You can use this package directly with npx (recommended):
npx create-once-ui-app@latestOr install it globally:
npm install -g create-once-ui-appUsage
Using npx (recommended)
npx create-once-ui-app@latestIf installed globally
create-once-ui-appFollow the interactive prompts to:
- Choose whether to use the current directory or create a new one
- If creating a new directory, provide a name for your project
The tool will then:
- Clone the Once UI Next.js starter kit
- Install all dependencies
- Set up your project and make it ready for development
Development
After creating your project:
- Navigate to your project directory (if a new directory was created)
- Start the development server:
npm run dev
How it Works
The tool performs the following steps:
- Checks if git is installed on your system
- Prompts you for project location preferences
- Clones the Once UI Next.js starter repository
- Automatically installs all required dependencies
- Sets up your project for immediate development
Requirements
- Node.js 14.0.0 or later
- Git installed on your system
- npm or yarn package manager
License
MIT
