{"id":28189951,"url":"https://github.com/itzzfirestuff/simple-electron-all-in-one-template","last_synced_at":"2025-05-16T10:11:48.300Z","repository":{"id":285522090,"uuid":"958055109","full_name":"ItzzFirestuff/Simple-Electron-All-in-One-Template","owner":"ItzzFirestuff","description":"Firestuff's Simple Electron All-in-One Template with Electron, Vite, React, Shadcn/ui , Tailwind (v3) and Electron-Builder","archived":false,"fork":false,"pushed_at":"2025-04-01T07:12:09.000Z","size":637,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T13:39:11.175Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ItzzFirestuff.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-31T15:11:55.000Z","updated_at":"2025-04-01T07:12:12.000Z","dependencies_parsed_at":"2025-04-01T08:27:25.106Z","dependency_job_id":"61172352-9bb6-4173-a8fc-3324d0600a01","html_url":"https://github.com/ItzzFirestuff/Simple-Electron-All-in-One-Template","commit_stats":null,"previous_names":["firestuffteam/simple-electron-all-in-one-template","itzzfirestuff/simple-electron-all-in-one-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ItzzFirestuff%2FSimple-Electron-All-in-One-Template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ItzzFirestuff%2FSimple-Electron-All-in-One-Template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ItzzFirestuff%2FSimple-Electron-All-in-One-Template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ItzzFirestuff%2FSimple-Electron-All-in-One-Template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ItzzFirestuff","download_url":"https://codeload.github.com/ItzzFirestuff/Simple-Electron-All-in-One-Template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254509475,"owners_count":22082896,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-16T10:11:44.065Z","updated_at":"2025-05-16T10:11:48.291Z","avatar_url":"https://github.com/ItzzFirestuff.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Firestuff's Simple Electron All-in-One Template\n\n🚀 A powerful and well-structured Electron boilerplate that integrates **React, Vite, TailwindCSS, ShadCN, and TypeScript** out of the box. This template is designed to provide an efficient and scalable starting point for building modern Electron apps.\n\n![Preview](app/assets/preview.png)\n\n## ✨ Features\n\n- **Electron + React + Vite** – Lightning-fast development experience.\n- **TailwindCSS (Old Version)** – More stable and widely preferred.\n- **ShadCN UI Components** – Clean and modern UI components.\n- **Custom Window Implementation** – Includes a custom titlebar and menu.\n- **Pre-configured ESLint \u0026 Prettier** – Enforced clean and consistent code.\n- **Well-Structured Codebase** – Organized folders for easy navigation.\n- **TypeScript Support** – Fully typed for better maintainability.\n\n## 🖥️ Custom Window Components\n\nThis template includes a custom window implementation with:\n\n- **Custom titlebar** with app icon\n- **Window control buttons** (minimize, maximize, close)\n- **Menu system** with keyboard shortcuts\n- **Dark/light mode toggle**\n- **Cross-platform support** for Windows and macOS\n\n### 🎛️ Titlebar Menu Toggle\n\nThe titlebar menu can be toggled using:\n\n- **Windows:** Press the `Alt` key\n- **macOS:** Press the `Option (⌥)` key\n\n#### How It Works:\n- If the menu is **hidden**, pressing the toggle key makes it **visible**.\n- If the menu is **already visible**, pressing the toggle key **hides** it.\n- The menu only toggles if menu items are available.\n\n### 🛠️ Customizing Menu Items\n\nTo add, remove, or modify menu items, update the `lib/window/titlebarMenus.ts` file.\n\n## 📁 Project Structure\n\n```\n├── app/                        # Renderer process files\n│   ├── assets/                 # Static assets (images, fonts, etc.)\n│   ├── components/             # React components\n│   │   ├── App.tsx             # Main Application component\n│   ├── styles/                 # Styling files (CSS \u0026 Tailwind)\n│   │   ├── app.css             # App stylesheet\n│   │   ├── globals.css         # Global styles\n│   │   └── tailwind.css        # Tailwind stylesheet\n│   ├── index.html              # Entry HTML file\n│   └── renderer.tsx            # Renderer process entry point\n├── lib/                        # Shared library code\n│   ├── main/                   # Main Electron process files\n│   │   ├── index.ts            # Electron entry point\n│   ├── preload/                # IPC preload scripts\n│   │   ├── index.ts            # Preload entry point\n│   │   └── api.ts              # Exposed API for renderer\n│   ├── welcome/                # Welcome components\n│   └── window/                 # Custom titlebar \u0026 menu\n├── resources/                  # Build resources\n├── .eslintrc                   # ESLint configuration\n├── .prettierrc                 # Prettier configuration\n├── electron-builder.yml        # Electron builder config\n├── electron.vite.config.ts     # Vite configuration\n├── package.json                # Dependencies \u0026 scripts\n├── tailwind.config.js          # Using the old version for stability\n├── postcss.config.js           # PostCSS configuration\n├── tsconfig.node.json          # TypeScript config for main process\n├── tsconfig.web.json           # TypeScript config for renderer\n```\n\n## 🚀 Getting Started\n\n### 1️⃣ Clone the Repository\n```sh\ngit clone https://github.com/firestuffteam/Simple-Electron-All-in-One-Template.git\ncd Simple-Electron-All-in-One-Template\n```\n\n### 2️⃣ Install Dependencies\n```sh\nyarn install  # or npm install\n```\n\n### 3️⃣ Start Development Server\n```sh\nyarn dev  # or npm run dev\n```\n\n### 4️⃣ Build for Production\n```sh\nyarn build  # or npm run build\n```\n\n## 📜 License\nThis project is **open-source** under the MIT License. Feel free to modify and use it for your projects!\n\n---\n\n🔥 Made with ❤️ by Firestuff\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitzzfirestuff%2Fsimple-electron-all-in-one-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitzzfirestuff%2Fsimple-electron-all-in-one-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitzzfirestuff%2Fsimple-electron-all-in-one-template/lists"}