/elegular

Electron + Angular quick start template with hot reload

Primary LanguageTypeScriptMIT LicenseMIT

Elegular

Description:

A preconfigured Electron + Angular 10 starter kit boilerplate with hot reload and others...

built with:

Project structure:

/elegular
  ├── build # Electron assets files (desktop icons etc...)
  ├── dist # Build output folder
  ├── release # Release output folder (build executable)
  ├── e2e
  ├── src # Angular source code
  ├── src-electron # Electron source code
  ├── .editorconfig
  ├── .gitignore
  ├── angular.json
  ├── package-lock.json
  ├── LICENCE.md
  ├── package.json
  ├── README.md
  ├── electron-builder.yml # electron-builder configuration
  ├── tsconfig.json
  └── tslint.json

Getting Started:

Prerequisites:

For run this project, you need to install the following:

Clone repository and install dependencies:

git clone --depth 1 https://github.com/radiium/elegular
cd elegular
npm install

Available commands:

Command Description
npm run start Start app in dev mode with hot-reload
npm run start:prod Start app in electron with prod mode
npm run start:web Start app in browser at http://localhost:4200 (without electron)
npm run release Build and release for the current target
npm run release -- -linux Build and release for Linux target
npm run release -- --mac Build and release for Mac target
npm run release -- -win Build and release for Windows target
npm run release:all Build and release for all platform target (linux/mac/windows)

License

MIT