{"id":15882544,"url":"https://github.com/ph1p/aio-electron-starter","last_synced_at":"2025-03-17T13:31:25.316Z","repository":{"id":37196695,"uuid":"232380732","full_name":"ph1p/aio-electron-starter","owner":"ph1p","description":"All in one electron starter","archived":false,"fork":false,"pushed_at":"2023-03-04T05:41:07.000Z","size":172031,"stargazers_count":4,"open_issues_count":4,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-28T00:15:33.369Z","etag":null,"topics":["contex","electron","electron-builder","simple","starter","tray","yarn"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ph1p.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-07T17:39:25.000Z","updated_at":"2021-10-07T15:26:57.000Z","dependencies_parsed_at":"2023-01-26T07:46:32.740Z","dependency_job_id":null,"html_url":"https://github.com/ph1p/aio-electron-starter","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/ph1p%2Faio-electron-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ph1p%2Faio-electron-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ph1p%2Faio-electron-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ph1p%2Faio-electron-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ph1p","download_url":"https://codeload.github.com/ph1p/aio-electron-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243864808,"owners_count":20360357,"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":["contex","electron","electron-builder","simple","starter","tray","yarn"],"created_at":"2024-10-06T04:04:40.723Z","updated_at":"2025-03-17T13:31:24.393Z","avatar_url":"https://github.com/ph1p.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# All in one electron starter\n\n## What is this?\n\nI was so often looking for a simple electron boilerplate that has already implemented all things like the tray icon, a builder and reloading the main process.\nAdditionally it should have as **few dependencies** as possible. I didn't really find what I was looking for, so I built this little starter kit.\n\n## Features\n\n- Tray-Icon support\n- TypeScript main process\n- Yarn workspaces ([https://classic.yarnpkg.com/en/docs/workspaces](https://classic.yarnpkg.com/en/docs/workspaces))\n- electron-builder\n- Auto reloading main process\n- A small plugin to set window size inside the vue files\n  - src/main/src/index.js | Start at line 48\n  - src/renderer/src/main.js | Start at line 12\n\n## Structure\n\n```bash\n├── app/\n│   └── resources/ # resources like the tray icon image\n│\n├── build/\n│   └── icons/ # application icon\n│\n├── src/\n│   ├── renderer/ # renderer process (e.g. react, vue, angular, svelte etc.)\n│   └── main/ # main process\n│   │   ├── src/ # all main files\n│   │   └── types/ # additional typing informations\n│\n├── .gitignore\n├── package.json\n└── README.md\n```\n\n### Renderer\n\n**You can also use any other framework/library, if you like**\n\n- Vue (created with the vue CLI)\n  - Vuex store\n    - Persisted start\n  - Router\n- Context menu\n\n## Commands\n\n### Install all packages and add/delete specific package\n\n```bash\nyarn install # install packages\n\nyarn workspace main add PACKAGE # install specific package for main process\n\nyarn workspace renderer add PACKAGE # install specific package for render process\n\nyarn workspace renderer remove PACKAGE # remove specific package from renderer process\n```\n\n### Run in dev mode\n\n```bash\nyarn start\n```\n\n### Build source code only\n\n```bash\nyarn build\n```\n\n### Build app with electron-builder\n\n```bash\nyarn build:app # Builds executable directly.\n\nyarn build:all # Build all. Linux, Windows and Mac.\n\nyarn build:mac # Build Mac\n\nyarn build:linux # Build Linux\n\nyarn build:windows # Build Windows\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fph1p%2Faio-electron-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fph1p%2Faio-electron-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fph1p%2Faio-electron-starter/lists"}