create-electron-shadcn-app/readme.md

Create Electron Forge apps with Vite, React, Tailwind and shadcn/ui only with one command.

# 🧪 create-electron-shadcn-app

[![npm version](https://img.shields.io/npm/v/create-electron-shadcn-app.svg?style=flat&color=blue)](https://www.npmjs.com/package/create-electron-shadcn-app)
[![npm downloads](https://img.shields.io/npm/dt/create-electron-shadcn-app.svg?style=flat&color=green)](https://www.npmjs.com/package/create-electron-shadcn-app)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

Create modern desktop applications using **Electron**, **Vite**, **React**, **Tailwind CSS**, and **shadcn/ui** — all with a single command.

> A CLI tool for quickly scaffolding Electron projects with responsive design and accessible shadcn UI components.

## 🚀 How to use

You can create a new project using:

```bash
npm create electron-shadcn-app@latest
```

Or with `npx`:

```bash
npx create-electron-shadcn-app@latest
```

Then follow the prompts to name and set up your new app.

## 📦 What's included

- ⚡ **Electron Forge** with **Vite** plugin
- ⚛️ **React** with **TypeScript**
- 🎨 **Tailwind CSS** preconfigured
- 💅 **shadcn/ui** with theme and accessibility support
- ✅ Ready-to-package Electron configuration
- 💻 Helpful scripts (`start`, `make`, `lint`, etc)

## 🛠️ Available scripts

```bash
npm start         # Launch the app in development mode
npm run make      # Package the app for production
```

## 🧪 Requirements

- Node.js >= 18
- npm >= 9

## 📦 Publishing

This CLI is available on [npm](https://www.npmjs.com/package/create-electron-shadcn-app).

Repository: [github.com/acrisiodejesus/create-electron-shadcn-app](https://github.com/acrisiodejesus/create-electron-shadcn-app)

## 🤝 Contributing

Pull requests are welcome! Feel free to suggest improvements, add templates, or new features.

## 📝 License

MIT © [Acrísio De Jesus](https://github.com/acrisiodejesus)