{"id":14977087,"url":"https://github.com/jooy2/retron","last_synced_at":"2025-07-15T11:15:01.163Z","repository":{"id":50458785,"uuid":"350959613","full_name":"jooy2/retron","owner":"jooy2","description":"📑 Vite + React + Electron + Material-UI Template. This is a skeleton template for easily creating React-based Electron projects.","archived":false,"fork":false,"pushed_at":"2025-07-08T09:57:00.000Z","size":3764,"stargazers_count":43,"open_issues_count":1,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-08T10:47:36.619Z","etag":null,"topics":["builder","cross-platform","electron","electron-boilerplate","electron-react-template","electron-template","material","material-ui","material-ui-react","mui","react","react-app","react-electron-template","redux","skeleton","template","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/jooy2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"jooy2","custom":["https://cdget.com/donate"]}},"created_at":"2021-03-24T05:42:59.000Z","updated_at":"2025-07-08T09:57:04.000Z","dependencies_parsed_at":"2023-12-23T17:16:46.579Z","dependency_job_id":"a4278351-60eb-453b-9284-26d7a11fa6a3","html_url":"https://github.com/jooy2/retron","commit_stats":{"total_commits":321,"total_committers":2,"mean_commits":160.5,"dds":0.3769470404984424,"last_synced_commit":"798527558c3b2afc5606ed95e0da12f674ad9997"},"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/jooy2/retron","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jooy2%2Fretron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jooy2%2Fretron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jooy2%2Fretron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jooy2%2Fretron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jooy2","download_url":"https://codeload.github.com/jooy2/retron/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jooy2%2Fretron/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265430558,"owners_count":23764003,"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":["builder","cross-platform","electron","electron-boilerplate","electron-react-template","electron-template","material","material-ui","material-ui-react","mui","react","react-app","react-electron-template","redux","skeleton","template","typescript"],"created_at":"2024-09-24T13:55:01.861Z","updated_at":"2025-07-15T11:15:01.116Z","avatar_url":"https://github.com/jooy2.png","language":"TypeScript","funding_links":["https://github.com/sponsors/jooy2","https://cdget.com/donate"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n![Retron-logo](src/renderer/public/images/retron-logo.webp)\n\n## Vite + Electron + React + Material-UI Template\n\n\u003e [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jooy2/retron/blob/main/LICENSE) ![Programming Language Usage](https://img.shields.io/github/languages/top/jooy2/retron) ![Languages](https://img.shields.io/github/languages/count/jooy2/retron) ![Commit Count](https://img.shields.io/github/commit-activity/y/jooy2/retron) ![github repo size](https://img.shields.io/github/repo-size/jooy2/retron) [![Followers](https://img.shields.io/github/followers/jooy2?style=social)](https://github.com/jooy2) ![Stars](https://img.shields.io/github/stars/jooy2/retron?style=social)\n\nThis is a skeleton template for easily creating React-based Electron projects.\n\nIt is configured to experience fast development and build speed using **[Vite](https://vitejs.dev)** bundler. As a bonus, it includes several React utilities and layout configurations.\n\n\u003c/div\u003e\n\n## Advantages of use\n\n- ✅ You can build immediately without any presets, so you can develop quickly.\n- ✅ It is being maintained quickly to be compatible with the latest `React` and `Electron`, as well as many modules.\n- ✅ There is no need to worry about layout and data management by using various additional templates.\n\n## Features\n\n- ⚡️ Rapid development through hot-reload\n- ⚡️ Cross-platform development and build support\n- ⚡️ Support for automated application testing\n- ⚡️ TypeScript support\n- ⚡️ Multilingual support\n- ⚡️ Support for themes (dark \u0026 light)\n- ⚡️ Basic layout manager\n- ⚡️ Global state management through the Redux store\n- ⚡️ Quick support through the GitHub community\n\n## Components\n\n- **For compile \u0026 build**\n\n  - `vite`\n  - `electron`\n  - `electron-builder` (Package builder)\n\n- **For web development framework**\n\n  - `react`\n  - `react-dom`\n  - `react-router-dom`\n  - `@redux/toolkit` \u0026 `react-redux` (Global state management)\n  - `typescript`\n\n- **For CSS Design**\n\n  - `@mui/material` (Material Design CSS Framework)\n  - `@emotion/react`\n\n- **For Multilingual language support**\n\n  - `i18next` (Multilingual translation)\n\n- **For development utils**\n\n  - `eslint` (Code syntax checking)\n  - `eslint-plugin-react-hooks`\n  - `prettier`\n\n- **For testing**\n\n  - `playwright`\n\n## Installation\n\nYou can easily clone a repository with just the npm command. (Recommend)\n\n```shell\n$ npm init retron\n```\n\nOR, Click **[Use this template](https://github.com/jooy2/retron/generate)** to instantly create your own project.\n\nOR, Clone this repo using below command.\n\n```shell\n$ git clone https://github.com/jooy2/retron \u003cPROJECT_NAME\u003e\n```\n\nThen, install the dependency module.\n\n```shell\n# via npm\n$ npm i\n\n# via yarn (https://yarnpkg.com)\n$ yarn install\n\n# via pnpm (https://pnpm.io)\n$ pnpm i\n```\n\nYou can test your project in the development environment using the following command:\n\n```shell\n$ npm run dev\n```\n\n## Build\n\n**Retron** can build targeting Windows 10 or later, macOS 14.x or later, and major Linux distributions.\n\n```shell\n# For Windows (.exe, .appx)\n$ npm run build:win\n\n# For macOS (.dmg)\n$ npm run build:mac\n\n# For Linux (.rpm, .deb, .snap)\n$ npm run build:linux\n```\n\nThe built packages can be found in `release/{version}` location.\n\n### Build settings for projects that use Native Node modules\n\nFor projects that use the **Native Node Module**, add the following script to your `package.json`: When installing dependencies, `electron-builder` will take care of any modules that require rebuilding.\n\n```json\n{\n  \"scripts\": {\n    \"postinstall\": \"electron-builder install-app-deps\"\n  }\n}\n```\n\n### What do I need to do for a multi-platform build?\n\n**macOS** is recommended if you want to build multiple platforms simultaneously on one platform. Because it can be configured with just a few very simple settings.\n\nYou can perform multi-platform builds at once with the following command. Alternatively, you can just do it for the OS you want via the individual build commands above.\n\n```shell\n$ npm run build\n```\n\n## Looking for Electron templates made with Vue?\n\nAlso check out the `Vutron` project, which consists of Vite + Vue 3 + Vuetify + Electron.\n\nhttps://github.com/jooy2/vutron\n\n## Contributing\n\nAnyone can contribute to the project by reporting new issues or submitting a pull request. For more information, please see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## License\n\nPlease see the [LICENSE](LICENSE) file for more information about project owners, usage rights, and more.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjooy2%2Fretron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjooy2%2Fretron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjooy2%2Fretron/lists"}