Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 1.78 KB

README.md

File metadata and controls

57 lines (40 loc) · 1.78 KB
Raw

electron-demo-startkit

Clone and run for a quick way to see 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.js - 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
# Go into the repository
cd electron-quick-start
# Install dependencies
npm install
# Run the app
npm start

package

npm install electron-packager -g

How to package

electron-packager source --out dest // source represent project position dest represent dest folder

How to generate doc

npm install -g doxmate  // dox standard

Generate doc

doxmate build

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

License

MIT