Skip to content

This project acts as a starter project for Electron applications to be built using React.js.

Notifications You must be signed in to change notification settings

henningta/electron-react-starter

Repository files navigation

Electron / Create-React-App Starter

This project acts as a starter project for Electron applications to be built using React.js.

Getting Started

To start building apps with this starter, just clone the project with git:

git clone --depth=1 https://github.com/henningta/electron-react-starter.git your-project-name

Then install and run the application with npm:

npm install
npm run dev

Scripts

Develop

npm run dev

Runs the app in development mode and subsequently runs an Electron container to load the app from http://localhost:3000.

This command uses a Procfile to coordinate npm run start with npm run electron and essentially combines both commands into a single, convenient one.

npm run electron-dev

Runs a new Electron container which attempts to load the app from http://localhost:3000. The app must be running before the container can load it.

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Build

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Test

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

About

This project acts as a starter project for Electron applications to be built using React.js.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published