Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matrixai/typescript-demo-electron
TypeScript Electron Demo Project using Nix
https://github.com/matrixai/typescript-demo-electron
electron nix typescript
Last synced: 2 months ago
JSON representation
TypeScript Electron Demo Project using Nix
- Host: GitHub
- URL: https://github.com/matrixai/typescript-demo-electron
- Owner: MatrixAI
- License: apache-2.0
- Created: 2021-03-05T00:48:17.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-04T01:38:56.000Z (over 3 years ago)
- Last Synced: 2024-04-28T07:21:08.676Z (9 months ago)
- Topics: electron, nix, typescript
- Language: Nix
- Homepage: https://matrix.ai
- Size: 620 KB
- Stars: 8
- Watchers: 9
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript-Demo-Electron
[](https://gitlab.com/MatrixAI/open-source/TypeScript-Demo-Electron/commits/master)
## Installation
Building the package:
```sh
nix-build -E '(import ./pkgs.nix {}).callPackage ./default.nix {}'
```
Building the releases:
```sh
nix-build ./release.nix --attr application
nix-build ./release.nix --attr docker
# packages for distribution
nix-build ./release.nix --attr package.linux.x64.deb
nix-build ./release.nix --attr package.linux.x64.rpm
nix-build ./release.nix --attr package.windows.x64.exe
nix-build ./release.nix --attr package.darwin.x64.zip
```
Install into Nix user profile:
```sh
nix-env -f ./release.nix --install --attr application
```
Install into Docker:
```sh
docker load --input "$(nix-build ./release.nix --attr docker)"
```
Running from Docker will require https://gist.github.com/CMCDragonkai/f7ca9b3ce8a64aa21ab68cf69dfc9f04
## Development
Run `nix-shell`, and once you're inside, you can use:
```
# install (or reinstall packages from package.json)
npm install
# build the development dist and watch for file changes
npm run watch
# build the production dist
npm run build
# run the repl (this allows you to import from ./src)
npm run ts-node
# run the tests
npm run test
# lint the source code
npm run lint
# automatically fix the source
npm run lintfix
```
If you want to run the Electron application, just run:
```
electron .
```
This will run against the `dist`.
Combine `npm run watch` with `electron .`.
Use manual refresh whenever the `dist` has been rebuilt.
---
**Known Development Pitfalls**:
* In the `webpack.config.js`, `svg` files use the `file-loader`. When important `svg`s as a vue component, using `vue-svg-loader`, configure the webpack as such:
REMOVE THE SVG FROM THE `file-loader`
In `electronRenderer`:
```js
{
test: /\.svg$/,
use: ['vue-loader', 'vue-svg-loader']
}
```
### Using the REPL
```
$ npm run ts-node
> import fs from 'fs';
> fs
> import { Library } from '@';
> Library
> import Library as Library2 from './src/lib/Library';
```
You can also create test files in `./src`, and run them with `npm run ts-node ./src/test.ts`.
This allows you to test individual pieces of typescript code and it makes it easier when doing large scale rearchitecting of TypeScript code.
### Webpack Configuration
The main is the `electronMain`, this compiles the node-side or "main" of electron.
The `electronRenderer` is the frontend side. This is similar to the SPA application. With style loader and stuff.
### Building Electron Application
You must use `umask 022` if you are interactively using `fakeroot` to build `deb` packages.
We are using `@electron-forge/cli` to build the electron apps for different platforms. The configuration can be found in `forge.config.js`.
It includes a list of [makers](https://www.electronforge.io/config/makers).
It also has `packageConfig`, which defines `electronZipDir`, which is the location for the cached electron binaries for different platforms. This gets used during the `nix-build` phase, as `nix` building is done in an offline environment, and requires caching ensure the required binaries used by `electron-forge` are present.
Note that the `electron` and `@electron-forge/cli` must be the same version between Nix specified dependencies and NPM specified dependencies. If they are not the same version, undefined behaviour may occur.