├── .env ├── .gitignore ├── LICENSE.md ├── README.md ├── electron-builder.env ├── electron └── main.js ├── package-lock.json ├── package.json ├── public ├── favicon.ico ├── index.html └── manifest.json └── src ├── assets └── images │ └── header.png ├── index.css ├── index.js ├── react ├── App.css ├── App.js ├── App.test.js └── logo.svg ├── serviceWorker.js └── shared └── constants.js /.env: -------------------------------------------------------------------------------- 1 | BROWSER=none -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | /node_modules 5 | /.pnp 6 | .pnp.js 7 | 8 | # testing 9 | /coverage 10 | 11 | # production 12 | /build 13 | /dist 14 | 15 | # misc 16 | .DS_Store 17 | .env.local 18 | .env.development.local 19 | .env.test.local 20 | .env.production.local 21 | 22 | npm-debug.log* 23 | yarn-debug.log* 24 | yarn-error.log* 25 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 Burhanuddin Udaipurwala 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![header](./src/assets/images/header.png) 2 | 3 | # Electron Create React App 4 | 5 | A boilerplate with zero dependencies other than React. Easy to use with single command run and packaging scripts 6 | 7 | ## Usage 8 | 9 | - Clone this repository 10 | - `cd` into the directory and delete git files `rm -rf .git` 11 | - Run `npm install` 12 | 13 | ## Development 14 | 15 | - Run `npm start` to start electron and react concurrently 16 | 17 | ## Build and package 18 | 19 | - Run `npm run package` to compile react, copy files and then package your app 20 | - A new `dist` folder will be created in the root of your project containing the executable files 21 | - NOTE: add `--mac` to the `postpackage` script besides `--win` if you are on a mac computer 22 | 23 | ## Project structure 24 | 25 | - `electron/`: Code for the main Electron process 26 | - `src/react/`: Code for the React renderer process 27 | - `src/shared/`: Code shared between React and Electron 28 | - `package.json`: Contains scripts for running the app in development, building it, and packaging it for production using electron-builder 29 | 30 | ## Contributing 31 | 32 | Open a new PR to contribute 33 | 34 | ## Credits 35 | 36 | Original idea by [johndyer24](https://github.com/johndyer24) 37 | 38 | ## License 39 | 40 | MIT 41 | -------------------------------------------------------------------------------- /electron-builder.env: -------------------------------------------------------------------------------- 1 | ELECTRON_BUILDER_ALLOW_UNRESOLVED_DEPENDENCIES=true 2 | -------------------------------------------------------------------------------- /electron/main.js: -------------------------------------------------------------------------------- 1 | const { app, BrowserWindow, ipcMain } = require("electron"); 2 | const path = require("path"); 3 | const url = require("url"); 4 | const { channels } = require("../src/shared/constants"); 5 | 6 | let mainWindow; 7 | 8 | function createWindow() { 9 | const startUrl = 10 | process.env.ELECTRON_START_URL || 11 | url.format({ 12 | pathname: path.join(__dirname, "../index.html"), 13 | protocol: "file:", 14 | slashes: true, 15 | }); 16 | mainWindow = new BrowserWindow({ 17 | width: 800, 18 | height: 600, 19 | webPreferences: { nodeIntegration: true }, 20 | }); 21 | mainWindow.loadURL(startUrl); 22 | mainWindow.on("closed", function() { 23 | mainWindow = null; 24 | }); 25 | } 26 | 27 | app.on("ready", createWindow); 28 | 29 | app.on("window-all-closed", function() { 30 | if (process.platform !== "darwin") { 31 | app.quit(); 32 | } 33 | }); 34 | 35 | app.on("activate", function() { 36 | if (mainWindow === null) { 37 | createWindow(); 38 | } 39 | }); 40 | 41 | ipcMain.on(channels.APP_INFO, (event) => { 42 | event.sender.send(channels.APP_INFO, { 43 | appName: app.getName(), 44 | appVersion: app.getVersion(), 45 | }); 46 | }); 47 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "electron-react-boilerplate", 3 | "version": "0.1.0", 4 | "productName": "Electron Create React App Boilerplate", 5 | "main": "electron/main.js", 6 | "private": true, 7 | "dependencies": { 8 | "react": "^16.13.1", 9 | "react-dom": "^16.13.1", 10 | "react-scripts": "2.1.3" 11 | }, 12 | "homepage": "./", 13 | "scripts": { 14 | "start": "npm-run-all -p start-react start-electron", 15 | "start-react": "BROWSER=none react-scripts start", 16 | "start-electron": "wait-on tcp:3000 && cross-env ELECTRON_START_URL=http://localhost:3000 electron .", 17 | "clean": "shx rm -rf build dist", 18 | "prepackage": "react-scripts build", 19 | "package": "shx mkdir build/src && shx cp -r electron/. build/electron && shx cp -r src/shared/. build/src/shared", 20 | "postpackage": "build --win -c.extraMetadata.main=build/electron/main.js --publish never", 21 | "test": "react-scripts test", 22 | "eject": "react-scripts eject" 23 | }, 24 | "build": { 25 | "files": [ 26 | "build/**/*", 27 | "node_modules/**/*" 28 | ], 29 | "publish": { 30 | "provider": "github", 31 | "repo": "electron-react-boilerplate", 32 | "owner": "burhanuday" 33 | } 34 | }, 35 | "eslintConfig": { 36 | "extends": "react-app" 37 | }, 38 | "browserslist": [ 39 | ">0.2%", 40 | "not dead", 41 | "not ie <= 11", 42 | "not op_mini all" 43 | ], 44 | "devDependencies": { 45 | "cross-env": "^5.2.1", 46 | "electron": "^7.3.2", 47 | "electron-builder": "^20.44.4", 48 | "npm-run-all": "^4.1.5", 49 | "shx": "^0.3.2", 50 | "wait-on": "^5.1.0" 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burhanuday/electron-react-boilerplate/2181cf2bdca71eccdff4f0d272cecf3910e5bf8e/public/favicon.ico -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 10 | 11 | 15 | 16 | 25 | React App 26 | 27 | 28 | 29 |
30 | 40 | 41 | 42 | -------------------------------------------------------------------------------- /public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "short_name": "React App", 3 | "name": "Create React App Sample", 4 | "icons": [ 5 | { 6 | "src": "favicon.ico", 7 | "sizes": "64x64 32x32 24x24 16x16", 8 | "type": "image/x-icon" 9 | } 10 | ], 11 | "start_url": ".", 12 | "display": "standalone", 13 | "theme_color": "#000000", 14 | "background_color": "#ffffff" 15 | } 16 | -------------------------------------------------------------------------------- /src/assets/images/header.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/burhanuday/electron-react-boilerplate/2181cf2bdca71eccdff4f0d272cecf3910e5bf8e/src/assets/images/header.png -------------------------------------------------------------------------------- /src/index.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | padding: 0; 4 | font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", 5 | "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", 6 | sans-serif; 7 | -webkit-font-smoothing: antialiased; 8 | -moz-osx-font-smoothing: grayscale; 9 | } 10 | 11 | code { 12 | font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New", 13 | monospace; 14 | } 15 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom'; 3 | import './index.css'; 4 | import App from './react/App'; 5 | import * as serviceWorker from './serviceWorker'; 6 | 7 | ReactDOM.render(, document.getElementById('root')); 8 | 9 | // If you want your app to work offline and load faster, you can change 10 | // unregister() to register() below. Note this comes with some pitfalls. 11 | // Learn more about service workers: http://bit.ly/CRA-PWA 12 | serviceWorker.unregister(); 13 | -------------------------------------------------------------------------------- /src/react/App.css: -------------------------------------------------------------------------------- 1 | .App { 2 | text-align: center; 3 | } 4 | 5 | .App-logo { 6 | animation: App-logo-spin infinite 20s linear; 7 | height: 40vmin; 8 | } 9 | 10 | .App-header { 11 | background-color: #282c34; 12 | min-height: 100vh; 13 | display: flex; 14 | flex-direction: column; 15 | align-items: center; 16 | justify-content: center; 17 | font-size: calc(10px + 2vmin); 18 | color: white; 19 | } 20 | 21 | .App-link { 22 | color: #61dafb; 23 | } 24 | 25 | @keyframes App-logo-spin { 26 | from { 27 | transform: rotate(0deg); 28 | } 29 | to { 30 | transform: rotate(360deg); 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/react/App.js: -------------------------------------------------------------------------------- 1 | import React, { Component } from 'react'; 2 | import logo from './logo.svg'; 3 | import './App.css'; 4 | import { channels } from '../shared/constants'; 5 | const { ipcRenderer } = window.require('electron'); 6 | 7 | 8 | class App extends Component { 9 | constructor(props) { 10 | super(props); 11 | this.state = { 12 | appName: '', 13 | appVersion: '', 14 | } 15 | ipcRenderer.send(channels.APP_INFO); 16 | ipcRenderer.on(channels.APP_INFO, (event, arg) => { 17 | ipcRenderer.removeAllListeners(channels.APP_INFO); 18 | const { appName, appVersion } = arg; 19 | this.setState({ appName, appVersion }); 20 | }); 21 | } 22 | 23 | render() { 24 | const { appName, appVersion } = this.state; 25 | return ( 26 |
27 |
28 | logo 29 |

{appName} version {appVersion}

30 |
31 |
32 | ); 33 | } 34 | } 35 | 36 | export default App; 37 | -------------------------------------------------------------------------------- /src/react/App.test.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom'; 3 | import App from './App'; 4 | 5 | it('renders without crashing', () => { 6 | const div = document.createElement('div'); 7 | ReactDOM.render(, div); 8 | ReactDOM.unmountComponentAtNode(div); 9 | }); 10 | -------------------------------------------------------------------------------- /src/react/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /src/serviceWorker.js: -------------------------------------------------------------------------------- 1 | // This optional code is used to register a service worker. 2 | // register() is not called by default. 3 | 4 | // This lets the app load faster on subsequent visits in production, and gives 5 | // it offline capabilities. However, it also means that developers (and users) 6 | // will only see deployed updates on subsequent visits to a page, after all the 7 | // existing tabs open on the page have been closed, since previously cached 8 | // resources are updated in the background. 9 | 10 | // To learn more about the benefits of this model and instructions on how to 11 | // opt-in, read http://bit.ly/CRA-PWA 12 | 13 | const isLocalhost = Boolean( 14 | window.location.hostname === 'localhost' || 15 | // [::1] is the IPv6 localhost address. 16 | window.location.hostname === '[::1]' || 17 | // 127.0.0.1/8 is considered localhost for IPv4. 18 | window.location.hostname.match( 19 | /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/ 20 | ) 21 | ); 22 | 23 | export function register(config) { 24 | if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) { 25 | // The URL constructor is available in all browsers that support SW. 26 | const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href); 27 | if (publicUrl.origin !== window.location.origin) { 28 | // Our service worker won't work if PUBLIC_URL is on a different origin 29 | // from what our page is served on. This might happen if a CDN is used to 30 | // serve assets; see https://github.com/facebook/create-react-app/issues/2374 31 | return; 32 | } 33 | 34 | window.addEventListener('load', () => { 35 | const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`; 36 | 37 | if (isLocalhost) { 38 | // This is running on localhost. Let's check if a service worker still exists or not. 39 | checkValidServiceWorker(swUrl, config); 40 | 41 | // Add some additional logging to localhost, pointing developers to the 42 | // service worker/PWA documentation. 43 | navigator.serviceWorker.ready.then(() => { 44 | console.log( 45 | 'This web app is being served cache-first by a service ' + 46 | 'worker. To learn more, visit http://bit.ly/CRA-PWA' 47 | ); 48 | }); 49 | } else { 50 | // Is not localhost. Just register service worker 51 | registerValidSW(swUrl, config); 52 | } 53 | }); 54 | } 55 | } 56 | 57 | function registerValidSW(swUrl, config) { 58 | navigator.serviceWorker 59 | .register(swUrl) 60 | .then(registration => { 61 | registration.onupdatefound = () => { 62 | const installingWorker = registration.installing; 63 | if (installingWorker == null) { 64 | return; 65 | } 66 | installingWorker.onstatechange = () => { 67 | if (installingWorker.state === 'installed') { 68 | if (navigator.serviceWorker.controller) { 69 | // At this point, the updated precached content has been fetched, 70 | // but the previous service worker will still serve the older 71 | // content until all client tabs are closed. 72 | console.log( 73 | 'New content is available and will be used when all ' + 74 | 'tabs for this page are closed. See http://bit.ly/CRA-PWA.' 75 | ); 76 | 77 | // Execute callback 78 | if (config && config.onUpdate) { 79 | config.onUpdate(registration); 80 | } 81 | } else { 82 | // At this point, everything has been precached. 83 | // It's the perfect time to display a 84 | // "Content is cached for offline use." message. 85 | console.log('Content is cached for offline use.'); 86 | 87 | // Execute callback 88 | if (config && config.onSuccess) { 89 | config.onSuccess(registration); 90 | } 91 | } 92 | } 93 | }; 94 | }; 95 | }) 96 | .catch(error => { 97 | console.error('Error during service worker registration:', error); 98 | }); 99 | } 100 | 101 | function checkValidServiceWorker(swUrl, config) { 102 | // Check if the service worker can be found. If it can't reload the page. 103 | fetch(swUrl) 104 | .then(response => { 105 | // Ensure service worker exists, and that we really are getting a JS file. 106 | const contentType = response.headers.get('content-type'); 107 | if ( 108 | response.status === 404 || 109 | (contentType != null && contentType.indexOf('javascript') === -1) 110 | ) { 111 | // No service worker found. Probably a different app. Reload the page. 112 | navigator.serviceWorker.ready.then(registration => { 113 | registration.unregister().then(() => { 114 | window.location.reload(); 115 | }); 116 | }); 117 | } else { 118 | // Service worker found. Proceed as normal. 119 | registerValidSW(swUrl, config); 120 | } 121 | }) 122 | .catch(() => { 123 | console.log( 124 | 'No internet connection found. App is running in offline mode.' 125 | ); 126 | }); 127 | } 128 | 129 | export function unregister() { 130 | if ('serviceWorker' in navigator) { 131 | navigator.serviceWorker.ready.then(registration => { 132 | registration.unregister(); 133 | }); 134 | } 135 | } 136 | -------------------------------------------------------------------------------- /src/shared/constants.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | channels: { 3 | APP_INFO: 'app_info', 4 | }, 5 | }; 6 | --------------------------------------------------------------------------------