Typescript template for electron ported to gitpod.
Find a file
2023-06-04 15:12:39 +05:30
.github Initial commit 2022-06-13 20:35:04 +05:30
src Initial commit 2022-06-13 20:35:04 +05:30
.eslintrc Initial commit 2022-06-13 20:35:04 +05:30
.gitignore Initial commit 2022-06-13 20:35:04 +05:30
.gitpod.Dockerfile Rename .gitpod.yml to .gitpod.Dockerfile 2022-06-13 20:35:47 +05:30
.gitpod.yml Create .gitpod.yml 2022-06-13 20:35:59 +05:30
index.html Initial commit 2022-06-13 20:35:04 +05:30
LICENSE.md Initial commit 2022-06-13 20:35:04 +05:30
package-lock.json Bump typescript from 5.0.4 to 5.1.3 2023-06-02 14:02:28 +00:00
package.json Bump typescript from 5.0.4 to 5.1.3 2023-06-02 14:02:28 +00:00
README.md Initial commit 2022-06-13 20:35:04 +05:30
tsconfig.json Initial commit 2022-06-13 20:35:04 +05:30

electron-quick-start-typescript

Clone and run for a quick way to see Electron in action.

This is a TypeScript port of the Electron Quick Start repo -- 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 Use

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/electron/electron-quick-start-typescript
# Go into the repository
cd electron-quick-start-typescript
# Install dependencies
npm install
# Run the app
npm start

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

Re-compile automatically

To recompile automatically and to allow using electron-reload, run this in a separate terminal:

npm run watch

Resources for Learning Electron

License

CC0 1.0 (Public Domain)