create-eleva-app v0.2.0-beta

Create Eleva App

Overview

Create Eleva App is an officially supported way to create Eleva.js applications. It offers a smooth development experience by providing a professional project structure, development server, modern Vite-based build system, and more.

Quick Start

# Using npx (recommended)
npx create-eleva-app my-app

# Using npm
npm init eleva-app my-app

# Using yarn
yarn create eleva-app my-app

# Using pnpm
pnpm create eleva-app my-app

Then follow the prompts to configure your project.

Features

• 🚀 Instant Setup: Go from zero to application in seconds
• 🔄 Interactive Experience: Helpful prompts guide you through setup
• 🧩 Optional Router: Easily add Eleva Router to your project
• 🛠️ Modern Build System: Powered by Vite for lightning-fast development
• 🎨 Elegant Structure: Professional project organization
• 📚 Best Practices: Follows Eleva.js recommended patterns
• 🔧 Fully Configurable: Customize to your project needs

Commands

# Create a new project with default settings
npx create-eleva-app my-app

# Skip prompts and use defaults
npx create-eleva-app my-app --yes

# Create a project with router
npx create-eleva-app my-app --router

# Create a project without router
npx create-eleva-app my-app --no-router

# Create a TypeScript project
npx create-eleva-app my-app --typescript

Project Structure

The generated project will have the following structure:

my-app/
├── public/                # Static assets
│   ├── favicon.ico
│   └── index.html
├── src/
│   ├── assets/            # Project assets
│   │   ├── styles/
│   │   │   └── main.css
│   │   └── images/
│   │       └── logo.svg
│   ├── components/        # Reusable components
│   │   ├── App.js
│   │   └── HelloWorld.js
│   ├── routes/            # Router-specific files (if enabled)
│   │   ├── Home.js
│   │   ├── About.js
│   │   └── NotFound.js
│   ├── routes.js          # Route definitions (if router enabled)
│   └── main.js            # Application entry point
├── .gitignore
├── package.json
├── README.md
└── vite.config.js

System Requirements

• Node.js 14.0.0 or later
• npm 6.0.0 or later, yarn 1.22.0 or later, or pnpm 6.0.0 or later

License

Create Eleva App is open-source software licensed under the MIT license.