electron-shadcn
Getting Started

Installation

Get started with electron-shadcn in minutes

GitHubEdit on GitHub

Prerequisites

Before you begin, ensure you have the following installed on your system:

  • Node.js (version 18 or higher)
  • npm (comes with Node.js) or your preferred package manager
  • Git for cloning the repository

Quick Start

Clone the Repository

You can either clone the repository directly or use it as a GitHub template.

git clone https://github.com/LuanRoger/electron-shadcn.git
cd electron-shadcn
  1. Go to electron-shadcn on GitHub
  2. Click the "Use this template" button
  3. Choose "Create a new repository"
  4. Clone your new repository

Install Dependencies

npm install

This will install all the required dependencies including Electron, React, Vite, and all the pre-configured tools.

Start the Development Server

npm run start

This will launch the Electron app in development mode with hot reload enabled.

What's Next?

After installation, you can start building your app by modifying /src/routes/index.tsx.

You can delete the /src/routes/second.tsx file if you don't need a second page in your application.

On this page