Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ph1p/aio-electron-starter
All in one electron starter
https://github.com/ph1p/aio-electron-starter
contex electron electron-builder simple starter tray yarn
Last synced: 3 months ago
JSON representation
All in one electron starter
- Host: GitHub
- URL: https://github.com/ph1p/aio-electron-starter
- Owner: ph1p
- Created: 2020-01-07T17:39:25.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T05:41:07.000Z (almost 2 years ago)
- Last Synced: 2024-10-13T04:13:23.872Z (4 months ago)
- Topics: contex, electron, electron-builder, simple, starter, tray, yarn
- Language: TypeScript
- Homepage:
- Size: 164 MB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# All in one electron starter
## What is this?
I 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.
Additionally 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.
## Features
- Tray-Icon support
- TypeScript main process
- Yarn workspaces ([https://classic.yarnpkg.com/en/docs/workspaces](https://classic.yarnpkg.com/en/docs/workspaces))
- electron-builder
- Auto reloading main process
- A small plugin to set window size inside the vue files
- src/main/src/index.js | Start at line 48
- src/renderer/src/main.js | Start at line 12
## Structure
```bash
├── app/
│ └── resources/ # resources like the tray icon image
│
├── build/
│ └── icons/ # application icon
│
├── src/
│ ├── renderer/ # renderer process (e.g. react, vue, angular, svelte etc.)
│ └── main/ # main process
│ │ ├── src/ # all main files
│ │ └── types/ # additional typing informations
│
├── .gitignore
├── package.json
└── README.md
```
### Renderer
**You can also use any other framework/library, if you like**
- Vue (created with the vue CLI)
- Vuex store
- Persisted start
- Router
- Context menu
## Commands
### Install all packages and add/delete specific package
```bash
yarn install # install packages
yarn workspace main add PACKAGE # install specific package for main process
yarn workspace renderer add PACKAGE # install specific package for render process
yarn workspace renderer remove PACKAGE # remove specific package from renderer process
```
### Run in dev mode
```bash
yarn start
```
### Build source code only
```bash
yarn build
```
### Build app with electron-builder
```bash
yarn build:app # Builds executable directly.
yarn build:all # Build all. Linux, Windows and Mac.
yarn build:mac # Build Mac
yarn build:linux # Build Linux
yarn build:windows # Build Windows
```