Clone and run for a quick way to see an Electron in action.
This is a minimal Electron application based on the Quick Start Guide within the Electron documentation.
Use this app along with the Electron API Demos app for API code examples to help you get started.
A basic Electron application needs just these files:
package.json- Points to the app's main file and lists its details and dependencies.main.ts- Starts the app and creates a browser window to render HTML. This is the app's main process.index.html- A web page to render. This is the app's renderer process.
You can learn more about each of these components within the Quick Start Guide.
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/Tichau/electron-typescript-starter
# Go into the repository
cd electron-typescript-starter
# Install dependencies and typings
npm install && npm run configure
# Run the app
npm start
# Run the app and watch changes in files
npm run watch
# Package your electron application for you current plateform
npm run pack
# Package your electron application for all supported plateforms
npm run pack-allLearn more about Electron and its API in the documentation.
For more example apps, see the list of boilerplates created by the awesome electron community.