{"id":19343179,"url":"https://github.com/swashcap/sample-electron-setup","last_synced_at":"2026-05-12T20:38:31.486Z","repository":{"id":149576276,"uuid":"42476874","full_name":"swashcap/sample-electron-setup","owner":"swashcap","description":"A sample setup for an Electron application.","archived":false,"fork":false,"pushed_at":"2015-09-14T21:42:51.000Z","size":132,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-06T12:41:52.469Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/swashcap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-14T21:02:44.000Z","updated_at":"2015-09-15T04:20:26.000Z","dependencies_parsed_at":"2023-04-18T23:32:08.192Z","dependency_job_id":null,"html_url":"https://github.com/swashcap/sample-electron-setup","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swashcap%2Fsample-electron-setup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swashcap%2Fsample-electron-setup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swashcap%2Fsample-electron-setup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swashcap%2Fsample-electron-setup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swashcap","download_url":"https://codeload.github.com/swashcap/sample-electron-setup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240449891,"owners_count":19803125,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T03:37:38.478Z","updated_at":"2026-05-12T20:38:26.456Z","avatar_url":"https://github.com/swashcap.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sample Electron Setup\n\n_A sample setup for an Electron application._\n\nHere’s what you get:\n\n* Easy task execution with [Grunt.js](http://gruntjs.com/)\n* Modern templating with [React](http://facebook.github.io/react/)\n* Fast development and builds with [Webpack](http://webpack.github.io/)\n* Linting with [ESLint](http://eslint.org/)\n* Testing with [tape](https://www.npmjs.com/package/tape)\n\n## Setup\n\n1. Install [Node.js](http://nodejs.org/)\n2. Install [Grunt.js](http://gruntjs.com/getting-started#installing-the-cli): `npm install -g grunt-cli`\n3. Clone the repository: `git clone git@github.com:swashcap/sample-electron-setup.git`\n4. Install dependencies: `cd sample-electron-setup \u0026\u0026 npm i`\n\n## Up and Running\n\n1. **Run `grunt webpack` in a terminal tab:** This will output Webpack development server and render process information.\n2. **Run `grunt` in a terminal tab:** This will output Electron's main process and crash reporter information.\n\nSee [project tasks](#project-tasks) for more info.\n\n## Files and Directory Structure\n\n```\n├── app                            Application code\n│   ├── main                         Files for Electron's 'main' process\n│   │   └── index.js                   Electron's entry point\n│   └── render                       Files for Electron's 'render' process\n│       ├── images                     Logos, images, etc.\n│       ├── index.html                 Entry HTML file\n│       ├── scripts                    Render scripts\n│       │   └── index.js                 Render scripts entry point\n│       └── styles                     Render styles\n│           └── main.css                 Main app styles\n├── dist                           Built application for distribution\n├── test                           All application tests\n├── webpack.config.base.js         Base Webpack config\n├── webpack.config.development.js  Webpack config for development\n├── webpack.config.production.js   Webpack config for production/distribution\n└── webpack.server.js              Webpack dev server (uses development config)\n```\n\n## Project Tasks\n\n* **grunt:** Open the Electron application for development. You’ll also need to run **grunt webpack** to build the project’s render files.\n* **grunt webpack:** Run the [Webpack](http://webpack.github.io/) development server.\n* **grunt debug:** Run Electron in debug mode with [node-inspector](https://www.npmjs.com/package/node-inspector). You’ll need to have node-insector [globally installed](https://www.npmjs.com/package/node-inspector#install).\n* **grunt build:** Build the application for distribution.\n* **grunt test:** Run [tape](https://www.npmjs.com/package/tape) tests.\n* **grunt lint:** Lint project files with [ESLint](http://eslint.org/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswashcap%2Fsample-electron-setup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswashcap%2Fsample-electron-setup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswashcap%2Fsample-electron-setup/lists"}