{"id":22316426,"url":"https://github.com/terrence-ou/npx-electron-react-shadcn","last_synced_at":"2026-04-06T01:34:22.545Z","repository":{"id":262164279,"uuid":"886404262","full_name":"terrence-ou/npx-electron-react-shadcn","owner":"terrence-ou","description":"An npx command-line tool to set up electron-react-shadcn project","archived":false,"fork":false,"pushed_at":"2024-11-20T17:45:46.000Z","size":19,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-03T14:33:46.388Z","etag":null,"topics":["electron","npx","react","shadcn-ui","tailwindcss","typescript","vite","vitest"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/electron-react-shadcn","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/terrence-ou.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2024-11-10T22:37:46.000Z","updated_at":"2025-11-04T12:46:54.000Z","dependencies_parsed_at":"2025-03-26T03:28:02.173Z","dependency_job_id":"f9c35161-61b0-48b6-a319-d8e84c0b68a8","html_url":"https://github.com/terrence-ou/npx-electron-react-shadcn","commit_stats":null,"previous_names":["terrence-ou/npx-electron-react-shadcn"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/terrence-ou/npx-electron-react-shadcn","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrence-ou%2Fnpx-electron-react-shadcn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrence-ou%2Fnpx-electron-react-shadcn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrence-ou%2Fnpx-electron-react-shadcn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrence-ou%2Fnpx-electron-react-shadcn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/terrence-ou","download_url":"https://codeload.github.com/terrence-ou/npx-electron-react-shadcn/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrence-ou%2Fnpx-electron-react-shadcn/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31456661,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T21:22:52.476Z","status":"ssl_error","status_checked_at":"2026-04-05T21:22:51.943Z","response_time":75,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["electron","npx","react","shadcn-ui","tailwindcss","typescript","vite","vitest"],"created_at":"2024-12-03T23:06:29.355Z","updated_at":"2026-04-06T01:34:22.526Z","avatar_url":"https://github.com/terrence-ou.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# electron-react-shadcn\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Required Node.JS \u003e= 18.0.0](https://img.shields.io/static/v1?label=node\u0026message=%20%3E=18.0.0\u0026logo=node.js\u0026color=3f893e)](https://nodejs.org/en/download/package-manager)\n\nAn npx cli for creating electron app with react and shadcn. The main template is located at [electron-react-shadcn](https://github.com/terrence-ou/electron-react-shadcn).\n\n```bash\nnpx electron-react-shadcn\n```\n\n## Overview\n\nThis Electron boilerplate enables developers to quickly build cross-platform apps using Electron, Vite, and React with Shadcn UI. Based on [@alex8088](https://github.com/alex8088)’s awesome `npm create @quick-start/electron` package, this template includes added styling (Tailwind, Shadcn UI) and testing libraries (Jest, Testing Library) to streamline setup and save development time.\n\n### Tech Stack\n\n| Category                  | Technology                                                                                  |\n|---------------------------|---------------------------------------------------------------------------------------------|\n| **Software Framework**    | [Electron](https://www.electronjs.org/)                                                     |\n| **Frontend Library**      | [React](https://react.dev/)                                                                 |\n| **Build Tool**            | [Vite](https://vite.dev/), [Electron-Vite](https://electron-vite.org/)                                                                   |\n| **UI and Styling**        | [shadcn](https://ui.shadcn.com/), [Tailwind](https://tailwindcss.com/)                      |\n| **Testing**               | [Vitest](https://vitest.dev), [Testing Library](https://testing-library.com/)                 |\n\n## Quick Start\n\n### Option 1 (Recommended): Use `npx electron-react-shadcn` to create a new project.\n\nYou can use this command to create a new project with this boilerplate directly in the directory. You can also setup and project name and theme colors by following the command prompts.\n\n```bash\n# create a new project using this boilerplate\nnpx electron-react-shadcn\n\n# navigate to the project folder\ncd electron-react-shadcn\n\n# install dependencies and run the project in dev mode\nnpm install \u0026\u0026 npm run dev\n```\n\n### Option 2: Clone this repository directly\n\nYou can use this boilerplate by directly downloading or clone this repository, and install the dependencies.\n\n```bash\n# clone this project\ngit clone https://github.com/terrence-ou/electron-react-shadcn.git\n\n# navigate to the project folder\ncd electron-react-shadcn\n\n# you can choose to remove the git info from this repo to avoid potential git conflicts\nsudo rm -r .git\n\n# install dependencies\nnpm install\n\n# start the project in dev mode\nnpm run dev\n```\n\n\n### Test and build commands\n\nThere're some pre-defined commands you might find useful\n\n```bash\n# run unit test\nnpm run test\n\n# run test coverage\nnpm run coverage\n\n# build app for different platforms\nnpm run build:mac # build for mac\nnpm run build:win # build for windows\nnpm run build:linux # build for linux\n```\n\n## Project Structure\n```\n├── resources/                      # Additional resources for the app\n├── src/                            # Main source code\n│   ├── main/                       # Main process code\n│   │   ├── lib/                    # Libraries for main process logic\n│   │   └── index.ts                # Entry point for the main process\n│   ├── preload/                    # Preload scripts\n│   │   ├── index.ts                # Preload script entry point\n│   │   └── index.d.ts              # TypeScript declarations for preload\n│   ├── renderer/                   # Renderer process code (front-end)\n│   │   ├── src/                    # Source for renderer\n│   │   │   ├── __tests__/          # Tests for renderer components\n│   │   │   ├── assets/             # Assets for the renderer\n│   │   │   ├── components/         # React components\n│   │   │   │   └── ui/             # Shadcn UI components\n│   │   │   └── utils/              # Utility functions\n│   │   ├── App.tsx                 # Main application component\n│   │   ├── env.d.ts                # TypeScript environment declarations\n│   │   ├── main.tsx                # Main entry point for the renderer\n│   │   └── index.html              # HTML template for the renderer\n│   └── shared/                     # Shared code between main and renderer\n├── .gitignore                      # Git ignore patterns\n├── components.json                 # Shadcn Components configuration\n├── electron.vite.config.ts         # Vite configuration for Electron\n├── vitest.config.mjs                # Vitest testing configuration\n├── LICENSE                         # Project license\n├── package.json                    # Project metadata and dependencies\n├── package-lock.json               # Dependency lock file\n├── postcss.config.js               # PostCSS configuration\n├── README.md                       # Project documentation\n├── tailwind.config.js              # Tailwind CSS configuration\n├── tsconfig.json                   # TypeScript configuration (general)\n├── tsconfig.node.json              # TypeScript configuration for Node.js\n└── tsconfig.web.json               # TypeScript configuration for web\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterrence-ou%2Fnpx-electron-react-shadcn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fterrence-ou%2Fnpx-electron-react-shadcn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterrence-ou%2Fnpx-electron-react-shadcn/lists"}