https://github.com/zewa666/aurelia-electron
An opinionated Electron starter template for Aurelia
https://github.com/zewa666/aurelia-electron
aurelia electron starter-template
Last synced: 5 months ago
JSON representation
An opinionated Electron starter template for Aurelia
- Host: GitHub
- URL: https://github.com/zewa666/aurelia-electron
- Owner: zewa666
- License: mit
- Created: 2020-01-27T07:01:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-01T11:02:35.000Z (about 5 years ago)
- Last Synced: 2024-11-15T08:28:45.968Z (7 months ago)
- Topics: aurelia, electron, starter-template
- Language: TypeScript
- Size: 14.1 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Aurelia Electron - Starter Template
This is a starter template for Aurelia with Electron. It does include:
* Jest for Frontend (renderer) and Backend (main) unit tests + code coverage
* TSLint with a custom rule set
* StyleLint optimized for SCSS and BEM workflows
Below you can find instructions on how to build, test and run the project.
## Structure
The folder `src` contains the frontend (renderer process), which is a standard Aurelia CLI app. The folder `backend` on the other hand represents the main process of Electron.
Once built, the output of the frontend is as usual the `scripts` folder, whereas the backend is `dist//backend`. If you intend to package the app, it might be better
to move the frontend output to `dist/frontend` as well so that all sources are at a single location.
If you change the `name` inside the `package.json` make sure to adjust the `main` property as well as the `electron` npm script to reflect the new name
## How to develop?
Start with installing all npm dependencies via `npm install`.
After that just run `npm start` within the root of the project and both the renderer/frontend (src) and main/backend (backend) will be automatically built and a watch mode started. As soon as either a frontend/backend file is modified, the app will be rebuilt and restarted automatically.
Tests can be executed with:
* `npm run test-backend` runs main process tests and generates coverage in test/backend/coverage-jest
* `npm run test-frontend` runs renderer process tests and generates coverage in test/frontend/coverage-jest
* `npm run tdd-backend` runs continuous main process tests
* `npm run tdd-frontend` runs continuous renderer process tests
* `npm run test-e2e` runs spectron e2e tests
* `npm run test` runs all unit tests (backend/frontend) at once with coverage outputs
## Building a binary release
To produce a binary with electron-builder, simply run `npm run dist`, which will create the output inside the `dist` folder.
> Notice that when running above command, you'll only build for the specific target you're on. So Mac will build for Mac, while Linux and Win will build respectively for their targets.
If you want to build for multiple targets, e.g on Mac you can build for Linux, Mac and Windows, just run `npm run dist-all`.
For further information about options please consult the [electron builder docs](https://www.electron.build/)
## Hooks
Before any push happens, a pre-push hook (Husky) will run all linters and tests to ensure no faulty code is pushed to the remote repository.
## NodeIntegration in Renderer
This sample makes use of NodeIntegration in the Render process to show how to distinguish Electron's require from the AMD one.
Typically you'd want to avoid the integration if not needed. In order to turn it off, comment out this section of the `main.ts` file
```typescript
webPreferences: {
nodeIntegration: true
},
```
If needed though, you can access electrons require method later in your renderer via `window.nodeRequire` as it's patched in the `index.html`.
Furthermore you'll notice a `window.electronRequire` which is needed for Spectron tests to access underlying processes during tests