Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/david-fernando/react-electron-ts
Boilerplate code for creating an Electron desktop app simply using Reactjs and Typescript
https://github.com/david-fernando/react-electron-ts
electron electron-app electron-boilerplate electron-react electron-react-boilerplate electron-react-es6 electron-react-typescript-template electron-reactjs electron-typescript electron-typescript-example electron-typescript-template electronjs react react-electron react-electron-app react-electron-typescript-template react-typescript react-typescript-electron react-typescripts reactjs
Last synced: about 4 hours ago
JSON representation
Boilerplate code for creating an Electron desktop app simply using Reactjs and Typescript
- Host: GitHub
- URL: https://github.com/david-fernando/react-electron-ts
- Owner: david-fernando
- License: mit
- Created: 2020-06-17T00:20:06.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-28T09:58:51.000Z (over 1 year ago)
- Last Synced: 2023-03-03T20:09:14.345Z (over 1 year ago)
- Topics: electron, electron-app, electron-boilerplate, electron-react, electron-react-boilerplate, electron-react-es6, electron-react-typescript-template, electron-reactjs, electron-typescript, electron-typescript-example, electron-typescript-template, electronjs, react, react-electron, react-electron-app, react-electron-typescript-template, react-typescript, react-typescript-electron, react-typescripts, reactjs
- Language: TypeScript
- Size: 2.31 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
React Electron with TypeScript
[](/LICENSE)
---
## Table of Contents
- [About](#about)
- [How to use](#usage)
- [Deploy to Desktop](#deploy)
##
About
Easy-to-understand-and-use boilerplate code for creating an Electron desktop app simply using Reactjs and TypeScript. Includes React Router
##
How to use
1. Clone this repository.
```
git clone https://github.com/david-fernando/react-electron-ts.git
```
2. If you havent already, install Yarn globally.
```
npm install -g yarn
```
3. Navigate into project root and install dependencies.
```
cd && npm install
```
4. Run dev server.
```
npm run start
```
##
Deploy to Desktop
1. Run the build process
```
npm run build
```
2. Go into your project folder using your file explorer. Navigate to the `dist` folder and open it. Then double-click `` Setup 0.1.0. Your app should open and there should now be an icon on your desktop for this app.
**Use a Custom Icon**
Add a 256 x 256 .png or .ico image in your public folder. It should be either `icon.ico` or `icon.png`. Update the `icon` property in your `package.json` if necessary. Currently, it uses an image called `icon.png`, which is a graphic of a coffee cup. You'll only see this in production. For more info, see the [electron-builder documentation](https://www.electron.build/icons)