README.md

@1fe/create-1fe-app

🚀 CLI tool to quickly scaffold a new 1fe instance

A command-line interface for creating new 1fe (One Frontend) instance

📋 Table of Contents

• Requirements
• Installation
• Usage
• Next Steps
• Troubleshooting
• Development

🔧 Requirements

• Node.js 22 or higher (enforced at runtime)
• yarn package manager

📦 Installation

Using npx (Recommended)

# Create a new 1fe app without installing globally
npx @1fe/create-1fe-app my-awesome-app

Using npm (Global Installation)

# Install globally
npm install -g @1fe/create-1fe-app

# Create a new app
create-1fe-app my-awesome-app

Using yarn (Global Installation)

# Install globally
yarn global add @1fe/create-1fe-app

# Create a new app
create-1fe-app my-awesome-app

🚀 Usage

Basic Usage

create-1fe-app <app-name>

Example

# Create a new app called "my-1fe-app"
create-1fe-app my-1fe-app

This will:

1. ✅ Verify Node.js version (must be 22+)
2. 🔗 Clone the latest 1fe starter template
3. 📁 Create a new directory with your app name
4. 🧹 Remove git history to start fresh

🎯 Next Steps

After creating your app, follow these steps:

1. Navigate to your app directory:

   cd my-app

2. Install dependencies:

   yarn

3. Start the development server:

   yarn dev

4. Open your browser:

   http://localhost:3001
   

5. Start building your app! 🎉

🔍 Troubleshooting

Node Version Error

🛑 Node.js version error!
Current version: v18.16.0
Minimum required version: 22.x.x

Solution: Update to Node.js 22 or higher:

# Using nvm (recommended)
nvm install 22
nvm use 22

# Or download from https://nodejs.org/

🔗 Related

• 1fe Documentation - Complete 1fe framework docs
• Starter Template - The template this tool clones

🤝 Community

If you have questions or want to discuss this project, please visit the Issues or Discussions pages in our monorepo.

---

Made with ❤️ by the 1fe team