{"id":16551257,"url":"https://github.com/michaelcurrin/electron-quickstart","last_synced_at":"2026-05-10T17:52:05.908Z","repository":{"id":93178147,"uuid":"289365101","full_name":"MichaelCurrin/electron-quickstart","owner":"MichaelCurrin","description":"Boilerplate for a simple Electron app","archived":false,"fork":false,"pushed_at":"2021-05-06T12:55:31.000Z","size":43,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-14T20:53:50.553Z","etag":null,"topics":["beginner","boilerplate","electron","javascript","quickstart"],"latest_commit_sha":null,"homepage":"","language":"HTML","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/MichaelCurrin.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-21T21:08:00.000Z","updated_at":"2021-05-06T12:55:34.000Z","dependencies_parsed_at":"2023-04-13T13:48:49.689Z","dependency_job_id":null,"html_url":"https://github.com/MichaelCurrin/electron-quickstart","commit_stats":null,"previous_names":[],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Felectron-quickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Felectron-quickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Felectron-quickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Felectron-quickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MichaelCurrin","download_url":"https://codeload.github.com/MichaelCurrin/electron-quickstart/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241876002,"owners_count":20035368,"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":["beginner","boilerplate","electron","javascript","quickstart"],"created_at":"2024-10-11T19:36:45.790Z","updated_at":"2026-05-10T17:52:05.844Z","avatar_url":"https://github.com/MichaelCurrin.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Electron.js Quickstart\n\u003e Boilerplate for a simple Electron app\n\n[![Known Vulnerabilities](https://snyk.io/test/github/MichaelCurrin/electron-quickstart/badge.svg?targetFile=package.json)](https://snyk.io/test/github/MichaelCurrin/electron-quickstart?targetFile=package.json)\n[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/electron-quickstart?include_prereleases=\u0026sort=semver)](https://github.com/MichaelCurrin/electron-quickstart/releases/)\n[![License](https://img.shields.io/badge/License-MIT-blue)](#license)\n\n[![Made with Node.js](https://img.shields.io/badge/Node.js-\u003e=12-blue?logo=node.js\u0026logoColor=white)](https://nodejs.org \"Node.js homepage\")\n[![Package - electron](https://img.shields.io/github/package-json/dependency-version/MichaelCurrin/electron-quickstart/dev/electron?logo=electron\u0026logoColor=white)](https://www.npmjs.com/package/electron)\n\n\n## Preview\n\n\u003cdiv align=center\u003e\n    \u003cimg src=\"sample.png\" alt=\"sample screenshot\" title=\"sample screenshot\" width=\"400\" /\u003e\n\u003c/div\u003e\n\n\n## About\n\nElectron is a JavaScript framework which lets you write desktop applications. Such as Facebook Messenger, Slack and Visual Studio Code. This project is a template to help you learn the basics and get a Hello World project running with minimal effort.\n\n\u003cdiv align=\"center\"\u003e\n\n[![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/electron-quickstart/generate)\n\n\u003c/div\u003e\n\n\n## Resources\n\nSee [Electron](https://michaelcurrin.github.io/dev-resources/resources/javascript/packages/electron/) in Dev Resources site.\n\n\n## Create your own app from scratch\n\nThis project's contents and the steps this section are based on the intro tutorial in the docs.\n\n- [Writing Your First Electron App](https://www.electronjs.org/docs/tutorial/first-app)\n\n```sh\n$ mkdir my-app\n$ npm init\n$ npm install --save-dev electron\n```\n\nSetup these files at minimum:\n\n- `index.html`\n- `main.js`\n\nCopy the content from the tutorial or from the scripts in this repo.\n\nAdd this to the `scripts` section of `package.json` - `\"start\": \"electron .\"`. \n\nNote that using `node main.js` will not work - the `require('electron')` import will just return a string (a path like `'.../node_modules/electron/dist/electron'`) and `app` will cause errors as it is undefined.\n\nRun your app with:\n\n```sh\n$ npm start\n```\n\n\n## Installation\n\nInstall Node.js - see [instructions](https://gist.github.com/aa1fc56419a355972b96bce23f3bccba).\n\nClone the repo.\n\nInstall dependencies.\n\n```sh\n$ npm install\n```\n\n\n## Usage\n\n```sh\n$ npm start\n```\n\n\n## License\n\nReleased under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelcurrin%2Felectron-quickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelcurrin%2Felectron-quickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelcurrin%2Felectron-quickstart/lists"}