https://github.com/syp1975/template-ts-vite-electron-react-tailwind

Typescript + Vite + Electron + React +Tailwind CSS boilerplate
https://github.com/syp1975/template-ts-vite-electron-react-tailwind

react tailwind template typescript vite

Last synced: about 1 month ago
JSON representation

Typescript + Vite + Electron + React +Tailwind CSS boilerplate

• Host: GitHub
• URL: https://github.com/syp1975/template-ts-vite-electron-react-tailwind
• Owner: syp1975
• Created: 2023-09-25T05:42:51.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-30T20:08:33.000Z (12 months ago)
• Last Synced: 2024-01-30T21:32:12.821Z (12 months ago)
• Topics: react, tailwind, template, typescript, vite
• Language: TypeScript
• Homepage:
• Size: 588 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## template-ts-vite-electron-react-tailwind

Based on [electron-vite-react](https://github.com/electron-vite/electron-vite-react)

## 👀 Overview

📦 Ready out of the box  

🎯 Based on the official [template-react-ts](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts), project structure will be familiar to you  

🌱 Easily extendable and customizable  

💪 Supports Node.js API in the renderer process  

🔩 Supports C/C++ native addons  

🐞 Debugger configuration included  

🖥 Easy to implement multiple windows  

## 🛫 Quick Setup

```sh

# clone the project

#git clone https://github.com/electron-vite/electron-vite-react.git

tiged syp1975/template-ts-vite-electron-react-tailwind my-project-name

# enter the project directory

cd my-project-name

# install dependency

npm install

# develop

npm run dev

```

## 📂 Directory structure

Familiar React application structure, just with `electron` folder on the top :wink:  

*Files in this folder will be separated from your React application and built into `dist-electron`*  

```tree

├── electron                                 Electron-related code

│   ├── main                                 Main-process source code

│   └── preload                              Preload-scripts source code

│

├── release                                  Generated after production build, contains executables

│   └── {version}

│       ├── {os}-{os_arch}                   Contains unpacked application executable

│       └── {app_name}_{version}.{ext}       Installer for the application

│

├── public                                   Static assets

└── src                                      Renderer source code, your React application

```

## 🔧 Additional features

1. electron-updater 👉 [see docs](src/components/update/README.md)

1. playwright

## ❔ FAQ

- [C/C++ addons, Node.js modules - Pre-Bundling](https://github.com/electron-vite/vite-plugin-electron-renderer#dependency-pre-bundling)

- [dependencies vs devDependencies](https://github.com/electron-vite/vite-plugin-electron-renderer#dependencies-vs-devdependencies)