{"id":16061193,"url":"https://github.com/robinfr/electron-react-typescript","last_synced_at":"2025-04-04T16:12:26.570Z","repository":{"id":28248306,"uuid":"117544978","full_name":"Robinfr/electron-react-typescript","owner":"Robinfr","description":"Electron boilerplate with React, Redux, and TypeScript","archived":false,"fork":false,"pushed_at":"2023-04-20T04:24:04.000Z","size":2088,"stargazers_count":430,"open_issues_count":11,"forks_count":86,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-05-16T12:05:36.648Z","etag":null,"topics":["boilerplate","electron","react","redux","typescript"],"latest_commit_sha":null,"homepage":null,"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/Robinfr.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":"2018-01-15T12:51:56.000Z","updated_at":"2024-05-30T01:30:04.767Z","dependencies_parsed_at":"2024-05-30T01:29:45.264Z","dependency_job_id":"ae84bbf3-5df8-43fe-9101-65745bd3089e","html_url":"https://github.com/Robinfr/electron-react-typescript","commit_stats":{"total_commits":54,"total_committers":4,"mean_commits":13.5,"dds":0.4814814814814815,"last_synced_commit":"b50263f06ecd518bfd43421a3c0bc3c3be308b64"},"previous_names":[],"tags_count":4,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Robinfr%2Felectron-react-typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Robinfr%2Felectron-react-typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Robinfr%2Felectron-react-typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Robinfr%2Felectron-react-typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Robinfr","download_url":"https://codeload.github.com/Robinfr/electron-react-typescript/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247208142,"owners_count":20901570,"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":["boilerplate","electron","react","redux","typescript"],"created_at":"2024-10-09T04:08:10.605Z","updated_at":"2025-04-04T16:12:26.552Z","avatar_url":"https://github.com/Robinfr.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# electron-react-typescript\n\n### A Boilerplate for an Easy Start with TypeScript, React, and Electron.\n\n[![React](docs/img/react.png)](https://reactjs.org/)\n[![Webpack](docs/img/webpack.png)](https://webpack.js.org/)\n[![TypeScript](docs/img/ts.png)](https://www.typescriptlang.org/)\n[![Electron](docs/img/electron.png)](https://electronjs.org/)\n[![Redux](docs/img/redux.png)](https://redux.js.org/)\n[![Jest](docs/img/jest.png)](https://facebook.github.io/jest/)\n\n[Electron](https://electronjs.org/) application boilerplate based on [React](https://reactjs.org/), [Redux](https://redux.js.org/), and [Webpack](https://webpack.js.org/) for rapid application development using [TypeScript](https://www.typescriptlang.org/).\n\n## Install\nClone the repository with Git:\n\n```bash\ngit clone --depth=1 git@github.com:Robinfr/electron-react-typescript.git \u003cyour-project-name\u003e\n```\n\nAnd then install the dependencies:\n\n```bash\ncd \u003cyour-project-name\u003e\nnpm install\n```\n\n## Usage\nBoth processes have to be started **simultaneously** in different console tabs:\n\n```bash\nnpm run start-renderer-dev\nnpm run start-main-dev\n```\n\nThis will start the application with hot-reload so you can instantly start developing your application.\n\nYou can also run do the following to start both in a single process:\n\n```bash\nnpm run start-dev\n```\n\n## Packaging\nWe use [Electron builder](https://www.electron.build/) to build and package the application. By default you can run the following to package for your current platform:\n\n```bash\nnpm run dist\n```\n\nThis will create a installer for your platform in the `releases` folder.\n\nYou can make builds for specific platforms (or multiple platforms) by using the options found [here](https://www.electron.build/cli). E.g. building for all platforms (Windows, Mac, Linux):\n\n```bash\nnpm run dist -- -mwl\n```\n\n## Husky and Prettier\nThis project comes with both Husky and Prettier setup to ensure a consistent code style. \n\nTo change the code style, you can change the configuration in `.prettierrc`. \n\nIn case you want to get rid of this, you can removing the following from `package.json`:\n\n1. Remove `precommit` from the `scripts` section\n1. Remove the `lint-staged` section\n1. Remove `lint-staged`, `prettier`, `eslint-config-prettier`, and `husky` from the `devDependencies`\n\nAlso remove all mentions of Prettier from the `extends` section in `.eslintrc.json`.\n\n## About this project\nThis project was set up from scratch but is heavily influenced by the [Electron React Boilerplate project](https://github.com/chentsulin/electron-react-boilerplate) and [React Redux TypeScript guide](https://github.com/piotrwitek/react-redux-typescript-guide).\n\n## License\nMIT © [R. Franken](https://github.com/Robinfr)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobinfr%2Felectron-react-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobinfr%2Felectron-react-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobinfr%2Felectron-react-typescript/lists"}