Clone and run for a quick way to see Electron in action.
This is an Electron template for developing cross-platform app with Typescript + React + Webpack. Fully configured for packaging and distribution. You can just follow the guides for packaing and publish.
Main Project Structure
pack-configuration: Configurations for packaging.config: Webpack configuration and path resolver.main: Electron main process.renderer: Renderer process (React)..env:
APPLE_PWD=XXXX-XXXX-XXXX-XXXX (Apple app-specific password. You can genereate here https://appleid.apple.com. Will be used for notarization)
APPLE_ID=XXX@XXXX.XXX (Apple ID. You can also get this from https://appleid.apple.com)\ PROVIDER=XXXXXXXXXX (Apple team ID)
PUBLIC_URL=.\
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
# Clone this repository
git clone https://github.com/ACE-Group/Typescript-Electron-React-Template
# Go into the repository
cd Typescript-Electron-React-Template
# Install dependencies
npm install or yarn install
# Run the app in dev mode
npm run dev or yarn dev
# Run the app in prod mode
npm run prod or yarn prod
# Package the app
npm run build or yarn buildNote: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.
- electronjs.org/docs - all of Electron's documentation
- electronjs.org/community#boilerplates - sample starter apps created by the community
- electron/electron-quick-start - a very basic starter Electron app
- electron/simple-samples - small applications with ideas for taking them further
- electron/electron-api-demos - an Electron app that teaches you how to use Electron
- hokein/electron-sample-apps - small demo apps for the various Electron APIs