@vite-powerflow/create

Generate a new, production-ready Vite PowerFlow starter project in seconds.

🚀 Quick Start

Prerequisites

• Node.js (v18 or higher)
• Your favorite code editor
• pnpm (or npm/yarn)
• Docker (optional, for containerized development)
• Dev Containers extension (optional, required only for Docker setup)

Setup Steps

1. Create project with CLI:

   npx @vite-powerflow/create my-app

   You can also run the CLI tool in non-interactive mode for faster setup. See CLI Options

2. Open the folder in your code editor:

   cd my-app
   code .  # or open with your preferred editor

3. Choose your preferred development approach:

🐳 Docker Setup

If you installed the Dev Containers extension, you'll see a "Reopen in Container" prompt:

1. Click Reopen in Container (or use the command palette)

   • The first time, wait for the installation (can take a few minutes)
   • On subsequent launches, you'll connect directly to the container

2. Launch dev server:

   pnpm dev

💻 Local Development

1. Install dependencies:

   pnpm install

2. Launch dev server:

   pnpm dev

Start developing! 🚀

CLI Options

The CLI tool supports the following options for non-interactive usage:

| Flag/Argument | Description | | ------------------------------ | -------------------------------------------- | | [project-directory] | The name of the project directory (required) | | -g, --git | Initialize Git repository | | -u, --git-user-name <name> | Git user.name (required with --git) | | -e, --git-user-email <email> | Git user.email (required with --git) | | -o, --use-global-git | Use global Git identity if found |

Documentation

• Website: vite-powerflow.netlify.app
• GitHub: Vite PowerFlow monorepo

For full documentation, features, and advanced usage, visit the official website or explore the repository.

MIT License