https://github.com/loopmode/react-desktop

starter project for desktop apps built with electron, webpack and react
https://github.com/loopmode/react-desktop

boilerplate electron react starter webpack

Last synced: 4 days ago
JSON representation

starter project for desktop apps built with electron, webpack and react

• Host: GitHub
• URL: https://github.com/loopmode/react-desktop
• Owner: loopmode
• Created: 2019-07-22T06:36:50.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T23:14:11.000Z (almost 2 years ago)
• Last Synced: 2024-05-29T19:05:18.555Z (6 months ago)
• Topics: boilerplate, electron, react, starter, webpack
• Language: JavaScript
• Homepage:
• Size: 5.32 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# react-desktop

Boilerplate for a react desktop application.

![development environment demo](demo.gif)

Based on [electron-webpack](https://github.com/electron-userland/electron-webpack) and [electron-webpack-quick-start](https://github.com/electron-userland/electron-webpack-quick-start).

Forked via https://github.com/loopmode/electron-webpack-quick-start/tree/react.

## electron-webpack-quick-start

> A bare minimum project structure to get started with [`electron-webpack`](https://github.com/electron-userland/electron-webpack).

Thanks to the power of `electron-webpack` this template comes packed with...

- Use of [`webpack-dev-server`](https://github.com/webpack/webpack-dev-server) for development

- HMR for both `renderer` and `main` processes

- Use of [`babel-preset-env`](https://github.com/babel/babel-preset-env) that is automatically configured based on your `electron` version

- Use of [`electron-builder`](https://github.com/electron-userland/electron-builder) to package and build a distributable electron application

Make sure to check out [`electron-webpack`'s documentation](https://webpack.electron.build/) for more details.

## Getting Started

Simply clone down this repository, install dependencies, and get started on your application.

The use of the [yarn](https://yarnpkg.com/) package manager is **strongly** recommended, as opposed to using `npm`.

```bash

# create a directory of your choice, and copy template using curl

mkdir new-electron-webpack-project && cd new-electron-webpack-project

curl -fsSL https://github.com/electron-userland/electron-webpack-quick-start/archive/master.tar.gz | tar -xz --strip-components 1

# or copy template using git clone

git clone https://github.com/electron-userland/electron-webpack-quick-start.git

cd electron-webpack-quick-start

rm -rf .git

# install dependencies

yarn

```

### Development Scripts

```bash

# run application in development mode

yarn dev

# compile source code and create webpack output

yarn compile

# `yarn compile` & create build with electron-builder

yarn dist

# `yarn compile` & create unpacked build with electron-builder

yarn dist:dir

```